PrerequisitesHigh level overview of the package |
|
---|---|
Create a package or research compendium structure |
|
Setup functionsThese four functions are usually the only ones user needs to run. The use of |
|
Store credentials to the .Rprofile |
|
Create an R package structure |
|
Create an R compendium structure |
|
Refresh a package/research compendium |
|
Create filesThese function write files specific to R package and research compendium ( |
|
Create a DESCRIPTION file |
|
Add a LICENSE |
|
Create a package-level documentation file |
|
Create a CITATION file |
|
Initialize units tests |
|
Create a vignette document |
|
Create a README file |
|
Create compendium folders |
|
Create a Make-like R file |
|
Initialize renv |
|
Create a Dockerfile |
|
README badgesThese functions add badges to the |
|
Add a CRAN Status badge |
|
Add a Dependencies badge |
|
Add a License badge |
|
Add a Life Cycle badge |
|
Add a Repository Status badge |
|
Add a R CMD Check badge |
|
Add a Website badge |
|
Add a Test coverage badge |
|
Add a Codecov badge |
|
Advanced functionsThese functions update fields in |
|
Add dependencies in DESCRIPTION |
|
Add minimal R version to DESCRIPTION |
|
Add to the .gitignore file |
|
Add to the .Rbuildignore file |
|
Setup GitHub Actions to check package |
|
Setup GitHub Actions to build and deploy package website |
|
Setup GitHub Actions to report code coverage |
|
Setup GitHub Actions to render README |
|
Utilities functionsThese functions return objects but do not edit any file. |
|
List all available licenses |
|
Get all external dependencies |
|
List all functions in the package |
|
Get required minimal R version |