writeProjectDescription: Write the project description.

In StoXProject/RstoxFramework: The Engine of StoX

Write the project description.

Description

Write the project description.

Usage

writeProjectDescription(
  projectPath,
  projectDescription = NULL,
  projectDescriptionFile = NULL,
  Application = R.version.string,
  optionalDependencies = FALSE,
  verbose = FALSE
)

Arguments

projectPath	The path to the StoX project, i.e., the folder of the project with the sub folders "input", "output" and "process". Can possibly be the path to a file inside the project folder.
projectDescription	The project description to write to the project.json file. Defaulted to NULL, in which case the project description is read for the project.
projectDescriptionFile	The path to the file holding the projectDescription.
Application	The application running StoX. Defaulted to the R.version.string, but can be a StoX version when run from the GUI.
optionalDependencies	Logical: If TRUE include also the column OptionalDependencies from the OfficialRstoxFrameworkVersions.txt file, which holds Rstox packages used in the Suggests field of the DESCRIPTION file.
verbose	Logical: If TRUE extra messages are printed to console.

StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.