Package: rcompendium 1.3.9000

Nicolas Casajus

rcompendium: Create a Package or Research Compendium Structure

Makes easier the creation of R package or research compendium (i.e. a predefined files/folders structure) so that users can focus on the code/analysis instead of wasting time organizing files. A full ready-to-work structure is set up with some additional features: version control, remote repository creation, CI/CD configuration (check package integrity under several OS, test code with 'testthat', and build and deploy website using 'pkgdown'). This package heavily relies on the R packages 'devtools' and 'usethis' and follows recommendations made by Wickham H. (2015) <ISBN:9781491910597> and Marwick B. et al. (2018) <doi:10.7287/peerj.preprints.3192v2>.

Authors:Nicolas Casajus [aut, cre, cph]

rcompendium_1.3.9000.tar.gz
rcompendium_1.3.9000.zip(r-4.5)rcompendium_1.3.9000.zip(r-4.4)rcompendium_1.3.9000.zip(r-4.3)
rcompendium_1.3.9000.tgz(r-4.4-any)rcompendium_1.3.9000.tgz(r-4.3-any)
rcompendium_1.3.9000.tar.gz(r-4.5-noble)rcompendium_1.3.9000.tar.gz(r-4.4-noble)
rcompendium_1.3.9000.tgz(r-4.4-emscripten)rcompendium_1.3.9000.tgz(r-4.3-emscripten)
rcompendium.pdf |rcompendium.html✨
rcompendium/json (API)
NEWS

# Install 'rcompendium' in R:
install.packages('rcompendium', repos = c('https://frbcesab.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/frbcesab/rcompendium/issues

On CRAN:

reproducible-researchresearch-compendium

6.74 score 39 stars 19 scripts 747 downloads 40 exports 100 dependencies

Last updated 1 months agofrom:bb5ccea768. Checks:OK: 5 NOTE: 2. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 24 2024
R-4.5-winNOTEOct 24 2024
R-4.5-linuxNOTEOct 24 2024
R-4.4-winOKOct 24 2024
R-4.4-macOKOct 24 2024
R-4.3-winOKOct 24 2024
R-4.3-macOKOct 24 2024

Exports:add_citationadd_code_of_conductadd_codecov_badgeadd_compendiumadd_contributingadd_cran_badgeadd_dependenciesadd_dependencies_badgeadd_descriptionadd_dockerfileadd_github_actions_checkadd_github_actions_check_badgeadd_github_actions_citationadd_github_actions_codecovadd_github_actions_codecov_badgeadd_github_actions_documentadd_github_actions_pkgdownadd_github_actions_pkgdown_badgeadd_github_actions_renderadd_licenseadd_license_badgeadd_lifecycle_badgeadd_makefileadd_package_docadd_r_dependadd_readme_rmdadd_renvadd_repostatus_badgeadd_testthatadd_to_buildignoreadd_to_gitignoreadd_vignetteget_all_dependenciesget_all_functionsget_licensesget_minimal_r_versionnew_compendiumnew_packagerefreshset_credentials

Dependencies:askpassbase64encbrewbriobslibcachemcallrcffrclicliprcommonmarkcpp11crayoncredentialscurldescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifastmapfontawesomefsgertghgitcredsgluegtoolshighrhtmltoolshtmlwidgetshttpuvhttr2inijquerylibjsonlitejsonvalidateknitrlaterlifecyclemagrittrmemoisemimeminiUIopensslpillarpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcpprematch2remotesrenvrlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinysourcetoolsstringistringrsyssystemfontstestthattextshapingtibbletinytexurlcheckerusethisutf8V8vctrswaldowhiskerwithrxfunxml2xopenxtableyamlzip

Developing an R package

Rendered fromdeveloping_a_package.Rmdusingknitr::rmarkdownon Oct 24 2024.

Last update: 2022-04-01
Started: 2022-03-26

Get started with rcompendium

Rendered fromrcompendium.Rmdusingknitr::rmarkdownon Oct 24 2024.

Last update: 2022-03-30
Started: 2021-03-08

Working with a Compendium

Rendered fromworking_with_a_compendium.Rmdusingknitr::rmarkdownon Oct 24 2024.

Last update: 2022-04-03
Started: 2022-03-26

Readme and manuals

Help Manual

Help pageTopics
Create a CITATION fileadd_citation
Add code of conductadd_code_of_conduct
Add a Codecov badgeadd_codecov_badge
Create additional foldersadd_compendium
Add contribution guidelinesadd_contributing
Add a CRAN Status badgeadd_cran_badge
Add dependencies in DESCRIPTIONadd_dependencies
Add a Dependencies badgeadd_dependencies_badge
Create a DESCRIPTION fileadd_description
Create a Dockerfileadd_dockerfile
Setup GitHub Actions to check packageadd_github_actions_check
Add a R CMD Check badgeadd_github_actions_check_badge
Setup GitHub Actions to update CITATION.cffadd_github_actions_citation
Setup GitHub Actions to report code coverageadd_github_actions_codecov
Add a Test coverage badgeadd_github_actions_codecov_badge
Setup GitHub Actions to document packageadd_github_actions_document
Setup GitHub Actions to build and deploy package websiteadd_github_actions_pkgdown
Add a Website badgeadd_github_actions_pkgdown_badge
Setup GitHub Actions to render READMEadd_github_actions_render
Add a LICENSEadd_license
Add a License badgeadd_license_badge
Add a Life Cycle badgeadd_lifecycle_badge
Create a Make-like R fileadd_makefile
Create a package-level documentation fileadd_package_doc
Add minimal R version to DESCRIPTIONadd_r_depend
Create a README fileadd_readme_rmd
Initialize renvadd_renv
Add a Repository Status badgeadd_repostatus_badge
Initialize units testsadd_testthat
Add to the .Rbuildignore fileadd_to_buildignore
Add to the .gitignore fileadd_to_gitignore
Create a vignette documentadd_vignette
Get all external dependenciesget_all_dependencies
List all functions in the packageget_all_functions
List all available licensesget_licenses
Get required minimal R versionget_minimal_r_version
Create an R compendium structurenew_compendium
Create an R package structurenew_package
Refresh a package/research compendiumrefresh
Store credentials to the .Rprofileset_credentials