Make DESCRIPTION file(s) from SpaDES module metadata
makeDESCRIPTIONproject(
modules,
modulePath,
projectPath = ".",
singleDESCRIPTION = TRUE,
package = "Project",
title = "Project",
description = "Project",
version = "1.0.0",
authors = Sys.info()["user"],
write = TRUE,
verbose = getOption("Require.verbose")
)
makeDESCRIPTION(
modules,
modulePath,
projectPath = ".",
singleDESCRIPTION = FALSE,
package,
title,
date,
description,
version,
authors,
write = TRUE,
verbose,
metadataList,
...
)A character vector of module names
Character. The path with modules, usually modulePath() or paths$modulePath
Character. Only used if singleDESCRIPTION = TRUE
Logical. If TRUE, there be only one DESCRIPTION file written
for all modules, i.e., all reqdPkgs will be trimmed for redundancies and put into the
single project-level DESCRIPTION file.
The name inserted into the "Package" entry in DESCRIPTION
The string inserted into the "Title" entry in DESCRIPTION
The string inserted into the "Description" entry in DESCRIPTION
The string inserted into the "Version" entry in DESCRIPTION
The string inserted into the "Authors" entry in DESCRIPTION
Logical. If TRUE, then it will write the DESCRIPTION file either in
the modulePath (if singleDESCRIPTION = FALSE) or projectPath
(if singleDESCRIPTION = TRUE)
Numeric or logical indicating how verbose should the function
be. If -1 or -2, then as little verbosity as possible. If 0 or FALSE,
then minimal outputs; if 1 or TRUE, more outputs; 2 even more. NOTE: in
Require function, when verbose >= 2, also returns details as if
returnDetails = TRUE (for backwards compatibility).
Date to enter into DESCRIPTION file. Defaults to Sys.Date()
The parsed source code from a module. Must include defineModule metadata.
Currently not used.