Create a Package or Research Compendium Structure
Create a CITATION file
Add code of conduct
Add a Codecov badge
Create additional folders
Add contribution guidelines
Add a CRAN Status badge
Add dependencies in DESCRIPTION
Add a Dependencies badge
Create a DESCRIPTION file
Create a Dockerfile
Setup GitHub Actions to check package
Add a R CMD Check badge
Setup GitHub Actions to update CITATION.cff
Setup GitHub Actions to report code coverage
Add a Test coverage badge
Setup GitHub Actions to document package
Setup GitHub Actions to build and deploy package website
Add a Website badge
Setup GitHub Actions to render README
Add a LICENSE
Add a License badge
Add a Life Cycle badge
Create a Make-like R file
Create a package-level documentation file
Add minimal R version to DESCRIPTION
Create a README file
Initialize renv
Add a Repository Status badge
Initialize units tests
Add to the .Rbuildignore file
Add to the .gitignore file
Create a vignette document
Get all external dependencies
List all functions in the package
List all available licenses
Get required minimal R version
Create an R compendium structure
Create an R package structure
Create a package or research compendium structure
Refresh a package/research compendium
Store credentials to the .Rprofile
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>.
Useful links