ExtDescriptionFile {biodb} | 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

- `ExtDescriptionFile$new()`

- `ExtDescriptionFile$clone()`

Inherited methods

- `biodb::ExtGenerator$generate()`

- `biodb::ExtGenerator$upgrade()`

#### Method `new()`

Constructor.

##### Usage

    ExtDescriptionFile$new(...)

##### Arguments

`...`

  See the constructor of ExtFileGenerator for the parameters.

##### Returns

A new instance.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    ExtDescriptionFile$clone(deep = FALSE)

##### Arguments

`deep`

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

[Package biodb version 1.0.4 Index]