Fill DESCRIPTION file of the package

fill_description(pkg = ".", fields, overwrite = FALSE)

Arguments

pkg

Path to package

fields

A named list of fields to add to DESCRIPTION, potentially overriding default values. See use_description for how you can set personalized defaults using package options

overwrite

Whether to overwrite existing DESCRIPTION

Value

FIll DESCRIPTION file with fields. Return path to file.

Examples

# Create a new project tmpdir <- tempdir() dummypackage <- file.path(tmpdir, "dummypackage") dir.create(dummypackage) fill_description( pkg = dummypackage, fields = list( Title = "Build A Package From Rmarkdown file", Description = paste("Use Rmd First method to build your package.", "Start your package with documentation.", "Everything can be set from a Rmd file in your project."), `Authors@R` = c( person("Sebastien", "Rochette", email = "sebastien@thinkr.fr", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-1565-9313")), person(given = "ThinkR", role = "cph") ) ) )
#> [1] "/private/var/folders/24/8k48jl6d249_n_qfxwsl6xvm0000gn/T/RtmpXCyytn/dummypackage/DESCRIPTION"
# Delete dummy package unlink(dummypackage, recursive = TRUE)