ExtDescriptionFile: Extension DESCRIPTION file
In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases
ExtDescriptionFile R Documentation
Extension DESCRIPTION file
Description
A class for generating a DESCRIPTION file for an extension package.
Details
This class generates a DESCRIPTION for a biodb extension package.
Super classes
biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtDescriptionFile
Methods
Public methods
Inherited methods
Method new()
Initializer.
Usage
ExtDescriptionFile$new(...)
Arguments
...See the constructor of ExtFileGenerator for the parameters.
Returns
Nothing.
Method clone()
The objects of this class are cloneable with this method.
Usage
ExtDescriptionFile$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# Generate the DESCRIPTION file:
pkgFolder <- file.path(tempfile(), 'biodbFoo')
dir.create(pkgFolder, recursive=TRUE)
biodb::ExtDescriptionFile$new(path=pkgFolder, dbName='foo.db',
dbTitle='Foo database', email='j.smith@e.mail',
firstname='John', lastname='Smith', rcpp=TRUE,
entryType='xml')$generate()
pkrog/biodb documentation built on Nov. 29, 2022, 4:24 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.
| ExtDescriptionFile | R Documentation |
Extension DESCRIPTION file
Description
A class for generating a DESCRIPTION file for an extension package.
Details
This class generates a DESCRIPTION for a biodb extension package.
Super classes
biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtDescriptionFile
Methods
Public methods
Inherited methods
Method new()
Initializer.
Usage
ExtDescriptionFile$new(...)
Arguments
...See the constructor of ExtFileGenerator for the parameters.
Returns
Nothing.
Method clone()
The objects of this class are cloneable with this method.
Usage
ExtDescriptionFile$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Examples
# Generate the DESCRIPTION file:
pkgFolder <- file.path(tempfile(), 'biodbFoo')
dir.create(pkgFolder, recursive=TRUE)
biodb::ExtDescriptionFile$new(path=pkgFolder, dbName='foo.db',
dbTitle='Foo database', email='j.smith@e.mail',
firstname='John', lastname='Smith', rcpp=TRUE,
entryType='xml')$generate()
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.