ExtConnClass: Extension connector clas

In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases

Extension connector clas

Description

A class for generating a new connector class.

Details

This class generates a new connector class from given parameters. The new class inherits from BiodbConn. It can be defined as a compound or mass database connector, and made downloadable, editable and/or writable.

Super classes

biodb::ExtGenerator -> biodb::ExtFileGenerator -> ExtConnClass

Methods

Public methods

• ExtConnClass$new()

• ExtConnClass$clone()

Inherited methods

• biodb::ExtGenerator$generate()
• biodb::ExtGenerator$upgrade()

---

Method new()

Initializer.

Usage

ExtConnClass$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

ExtConnClass$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Generate a new connector class inside R folder:
pkgFolder <- file.path(tempfile(), 'biodbFoo')
dir.create(pkgFolder, recursive=TRUE)
biodb::ExtConnClass$new(path=pkgFolder, dbName='foo.db',
                        dbTitle='Foo database',
                        connType='mass', remote=TRUE)$generate()

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