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>.
| Version: | 1.4 |
| Depends: | R (≥ 2.10) |
| Imports: | cffr, cli, codemetar, devtools, gert, gh, gtools, renv, rmarkdown, rstudioapi, stringr, usethis, utils, xfun |
| Suggests: | fs, knitr, testthat (≥ 3.0.0), withr |
| Published: | 2025-09-02 |
| DOI: | 10.32614/CRAN.package.rcompendium |
| Author: | Nicolas Casajus 
[aut, cre, cph] |
| Maintainer: | Nicolas Casajus <nicolas.casajus at fondationbiodiversite.fr> |
| BugReports: | https://github.com/FRBCesab/rcompendium/issues |
| License: | GPL-2 | GPL-3 [expanded from: GPL (≥ 2)] |
| URL: | https://github.com/FRBCesab/rcompendium, https://frbcesab.github.io/rcompendium/ |
| NeedsCompilation: | no |
| Citation: | rcompendium citation info |
| Materials: | README, NEWS |
| In views: | ReproducibleResearch |
| CRAN checks: | rcompendium results |
Documentation:
| Reference manual: | rcompendium.html , rcompendium.pdf |
| Vignettes: |
Developing an R package (source, R code) Get started with rcompendium (source, R code) Working with a Compendium (source, R code) |
Downloads:
| Package source: | rcompendium_1.4.tar.gz |
| Windows binaries: | r-devel: rcompendium_1.4.zip, r-release: rcompendium_1.4.zip, r-oldrel: rcompendium_1.4.zip |
| macOS binaries: | r-release (arm64): rcompendium_1.4.tgz, r-oldrel (arm64): rcompendium_1.4.tgz, r-release (x86_64): rcompendium_1.4.tgz, r-oldrel (x86_64): rcompendium_1.4.tgz |
| Old sources: | rcompendium archive |
Linking:
Please use the canonical form https://CRAN.R-project.org/package=rcompendium to link to this page.