getDESCRIPTION: Utility functions for getting and adding imports,...
In imr-stox/RstoxBuild: Package for Building All Rstox Packages
getDESCRIPTION R Documentation
Utility functions for getting and adding imports, DESCRIPTION, README and kgname to the package.
Description
getDESCRIPTION gets the DESCRIPTION text to write to the DESCRIPTION file, adding authors, R-dependency, title, description and other info stored in the input spec. Note that the package imports are not added here, but later in the addImportsToDESCRIPTION function.
getREADME gets the README file in the Rstox style, which has package and R version in the first two lines, followed by description, install instructions, miscellaneous info, and release notes retrieved from the NEWS file.
addImportsToDESCRIPTION adds the imports to the DESCRIPTION file.
getPkgname gets the pkgname text to write to the pkgname.R file.
Usage
getDESCRIPTION(spec)
addImportsToDESCRIPTION(spec, cpp = FALSE)
getPkgname(spec)
Arguments
spec
A list of package specifications returned from packageSpecs.
imr-stox/RstoxBuild documentation built on June 12, 2025, 9:59 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| getDESCRIPTION | R Documentation |
Utility functions for getting and adding imports, DESCRIPTION, README and kgname to the package.
Description
getDESCRIPTION gets the DESCRIPTION text to write to the DESCRIPTION file, adding authors, R-dependency, title, description and other info stored in the input spec. Note that the package imports are not added here, but later in the addImportsToDESCRIPTION function.
getREADME gets the README file in the Rstox style, which has package and R version in the first two lines, followed by description, install instructions, miscellaneous info, and release notes retrieved from the NEWS file.
addImportsToDESCRIPTION adds the imports to the DESCRIPTION file.
getPkgname gets the pkgname text to write to the pkgname.R file.
Usage
getDESCRIPTION(spec)
addImportsToDESCRIPTION(spec, cpp = FALSE)
getPkgname(spec)
Arguments
spec |
A list of package specifications returned from |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.