Package: rcompendium 2.0.0.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_2.0.0.9000.tar.gz
rcompendium_2.0.0.9000.zip(r-4.7)rcompendium_2.0.0.9000.zip(r-4.6)rcompendium_2.0.0.9000.zip(r-4.5)
rcompendium_2.0.0.9000.tgz(r-4.6-any)rcompendium_2.0.0.9000.tgz(r-4.5-any)
rcompendium_2.0.0.9000.tar.gz(r-4.7-any)rcompendium_2.0.0.9000.tar.gz(r-4.6-any)
rcompendium_2.0.0.9000.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
rcompendium/json (API)
NEWS

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

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

Pkgdown/docs site:https://frbcesab.github.io

On CRAN:

Conda:

reproducible-researchresearch-compendium

7.11 score 40 stars 27 scripts 843 downloads 41 exports 97 dependencies

Last updated from:344136811e. Checks:2 ERROR, 2 OK, 5 NOTE. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64ERROR169
source / vignettesOK196
linux-release-x86_64ERROR167
macos-release-arm64NOTE124
macos-oldrel-arm64NOTE117
windows-develNOTE113
windows-releaseNOTE113
windows-oldrelNOTE121
wasm-releaseOK137

Exports:add_citationadd_code_of_conductadd_codecov_badgeadd_codeownersadd_compendiumadd_contributingadd_cran_downloads_badgeadd_cran_total_download_badgeadd_cran_version_badgeadd_dependabotadd_dependenciesadd_dependencies_badgeadd_descriptionadd_dockerfileadd_github_actionadd_github_actions_check_badgeadd_github_actions_codecov_badgeadd_github_actions_pkgdown_badgeadd_issue_templateadd_licenseadd_license_badgeadd_lifecycle_badgeadd_makefileadd_package_docadd_r_dependadd_readme_rmdadd_renvadd_repostatus_badgeadd_testthatadd_to_buildignoreadd_to_gitignoreadd_vignettecreate_new_compendiumcreate_new_packageget_all_dependenciesget_all_functionsget_available_gh_actionsget_available_issue_templatesget_available_licensesget_minimal_r_versionset_credentials

Dependencies:askpassbase64encbrewbriobslibcachemcallrclicliprcommonmarkcpp11crayoncredentialscurldescdevtoolsdiffobjdigestdownlitellipsisevaluatefansifastmapfontawesomefsgertghgitcredsgluegtoolshighrhtmltoolshtmlwidgetshttpuvhttr2inijquerylibjsonliteknitrlaterlifecyclemagrittrmemoisemimeminiUIopensslotelpakpillarpkgbuildpkgconfigpkgdownpkgloadpraiseprettyunitsprocessxprofvispromisespspurrrR6raggrappdirsrcmdcheckRcpprenvrlangrmarkdownroxygen2rprojrootrstudioapirversionssasssessioninfoshinysourcetoolsstringistringrsyssystemfontstestthattextshapingtibbletinytexurlcheckerusethisutf8vctrswaldowhiskerwithrxfunxml2xopenxtableyamlzip

Developing an R package

Rendered fromdeveloping_a_package.Rmdusingknitr::rmarkdownon May 09 2026.

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

Get started with rcompendium

Rendered fromrcompendium.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2026-04-26
Started: 2021-03-08

Working with a Compendium

Rendered fromworking_with_a_compendium.Rmdusingknitr::rmarkdownon May 09 2026.

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

Readme and manuals

Help Manual

Help pageTopics
Create a CITATION fileadd_citation
Add a CODE OF CONDUCT fileadd_code_of_conduct
Add a Codecov badgeadd_codecov_badge
Create a CODEOWNERS fileadd_codeowners
Create additional foldersadd_compendium
Add a CONTRIBUTING fileadd_contributing
Add CRAN monthly downloads badgeadd_cran_downloads_badge
Add CRAN total download badgeadd_cran_total_download_badge
Add a CRAN version badgeadd_cran_version_badge
Add a DEPENDABOT fileadd_dependabot
Add dependencies in DESCRIPTIONadd_dependencies
Add a Dependencies badgeadd_dependencies_badge
Add a DESCRIPTION fileadd_description
Create a Dockerfileadd_dockerfile
Set up a GitHub Action workflowadd_github_action
Add a R CMD Check badgeadd_github_actions_check_badge
Add a Test coverage badgeadd_github_actions_codecov_badge
Add a Website badgeadd_github_actions_pkgdown_badge
Set up an Issue Template fileadd_issue_template
Add a LICENSE fileadd_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
Create an R compendium structurecreate_new_compendium
Create an R package structurecreate_new_package
Get all external dependenciesget_all_dependencies
List all functions in the packageget_all_functions
List available GitHub Actionsget_available_gh_actions
List available ISSUE TEMPLATEget_available_issue_templates
List all available licensesget_available_licenses
Get required minimal R versionget_minimal_r_version
Store user information in the .Rprofileset_credentials