add_compendium: Create compendium folders

Description Usage Arguments Value See Also Examples

View source: R/add_compendium.R

Description

This function creates the following additional folders data/, rscripts/, outputs/, figures/, and paper/. Each folder has a README to provide instructions. The argument compendium allows user to choose if these folders are created at the root of the project (default) or nested inside a parent directory. All theses folders area added to .Rbuildignore.

Usage

1
add_compendium(compendium = ".")

Arguments

compendium

a character of length 1

By default, compendium folders are created at the root of the project. User can change their location with this argument. For instance, if compendium = 'analysis', compendium folders will be created inside the directory analysis/.

Value

None

See Also

Other create files: add_citation(), add_description(), add_license(), add_makefile(), add_package_doc(), add_readme_rmd(), add_testthat(), add_vignette()

Examples

1
2
3
4
## Not run: 
add_compendium()

## End(Not run)

rcompendium documentation built on March 24, 2021, 5:06 p.m.