ExtDefinitions: Extension defintions file class

ExtDefinitionsR Documentation

Extension defintions file class

Description

A class for generating the definitions.yml file of a new extension package.

Details

This class generates the definitions.yml of a new extension package, needed for definining the new connector.

Super classes

biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtDefinitions

Methods

Public methods

Inherited methods

Method new()

Initializer.

Usage
ExtDefinitions$new(...)
Arguments
...

See the constructor of ExtFileGenerator for the parameters. offers this possiblity.

Returns

Nothing.


Method clone()

The objects of this class are cloneable with this method.

Usage
ExtDefinitions$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

# Generate the biodb definitions.yml file inside "inst" folder:
pkgFolder <- file.path(tempfile(), 'biodbFoo')
dir.create(pkgFolder, recursive=TRUE)
biodb::ExtDefinitions$new(path=pkgFolder, dbName='foo.db',
                          dbTitle='Foo database')$generate()


pkrog/biodb documentation built on Nov. 29, 2022, 4:24 a.m.