ExtReadme {biodb} | R Documentation |
A class for generating a README file for a new extension package.
Write a README file inside package directory, using a template file.
biodb::ExtGenerator
-> biodb::ExtFileGenerator
-> ExtReadme
new()
Constructor
ExtReadme$new(...)
...
See the constructor of ExtFileGenerator for the parameters.
A new instance.
clone()
The objects of this class are cloneable with this method.
ExtReadme$clone(deep = FALSE)
deep
Whether to make a deep clone.
# Generate a new package: pkgFolder <- file.path(tempfile(), 'biodbFoo') dir.create(pkgFolder, recursive=TRUE) biodb::ExtReadme$new(path=pkgFolder, dbName='foo.db', dbTitle='Foo database')$generate()