ExtDefinitions {biodb} | R 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

- `ExtDefinitions$new()`

- `ExtDefinitions$clone()`

Inherited methods

- `biodb::ExtGenerator$generate()`

- `biodb::ExtGenerator$upgrade()`

#### Method `new()`

Constructor

##### Usage

    ExtDefinitions$new(...)

##### Arguments

`...`

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

#### 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()

[Package biodb version 1.0.4 Index]