This function creates a compendium, i.e. additional folders to a package
structure. By default, the following directories are created:
data/raw-data
, data/derived-data
, analyses/
, outputs/
, and
figures/
. A README.md
is added to each folder and must be edited. The
argument compendium
allows user to choose its own compendium structure.
All theses folders are added to the .Rbuildignore
file.
add_compendium(compendium = NULL, quiet = FALSE)
A character vector specifying the folders to be created.
A logical value. If TRUE
messages are deleted. Default is
FALSE
.
No return value.
Other create files:
add_citation()
,
add_code_of_conduct()
,
add_contributing()
,
add_description()
,
add_dockerfile()
,
add_license()
,
add_makefile()
,
add_package_doc()
,
add_readme_rmd()
,
add_renv()
,
add_testthat()
,
add_vignette()
if (FALSE) {
add_compendium()
add_compendium(compendium = "paper")
add_compendium(compendium = c("data", "outputs", "code", "manuscript"))
}