HmdbMetabolitesEntry {biodbHmdb} | R Documentation

## HMDB Metabolites entry class.

### Description

HMDB Metabolites entry class.

HMDB Metabolites entry class.

### Details

This is the entry class for the HMDB Metabolites database.

### Super classes

`biodb::BiodbEntry` -> `biodb::BiodbXmlEntry` -> `HmdbMetabolitesEntry`

### Methods

#### Public methods

- `HmdbMetabolitesEntry$new()`

- `HmdbMetabolitesEntry$clone()`

Inherited methods

- `biodb::BiodbEntry$appendFieldValue()`

- `biodb::BiodbEntry$cloneInstance()`

- `biodb::BiodbEntry$computeFields()`

- `biodb::BiodbEntry$fieldHasBasicClass()`

- `biodb::BiodbEntry$getBiodb()`

- `biodb::BiodbEntry$getDbClass()`

- `biodb::BiodbEntry$getField()`

- `biodb::BiodbEntry$getFieldCardinality()`

- `biodb::BiodbEntry$getFieldClass()`

- `biodb::BiodbEntry$getFieldDef()`

- `biodb::BiodbEntry$getFieldNames()`

- `biodb::BiodbEntry$getFieldValue()`

- `biodb::BiodbEntry$getFieldsAsDataframe()`

- `biodb::BiodbEntry$getFieldsAsJson()`

- `biodb::BiodbEntry$getFieldsByType()`

- `biodb::BiodbEntry$getId()`

- `biodb::BiodbEntry$getName()`

- `biodb::BiodbEntry$getParent()`

- `biodb::BiodbEntry$hasField()`

- `biodb::BiodbEntry$isNew()`

- `biodb::BiodbEntry$makesRefToEntry()`

- `biodb::BiodbEntry$parentIsAConnector()`

- `biodb::BiodbEntry$parseContent()`

- `biodb::BiodbEntry$print()`

- `biodb::BiodbEntry$removeField()`

- `biodb::BiodbEntry$setField()`

- `biodb::BiodbEntry$setFieldValue()`

#### Method `new()`

New instance initializer. Connector classes must not be instantiated directly. Instead, you must use the createConn() method of the factory class.

##### Usage

    HmdbMetabolitesEntry$new(...)

##### Arguments

`...`

  All parameters are passed to the super class initializer.

##### Returns

Nothing.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    HmdbMetabolitesEntry$clone(deep = FALSE)

##### Arguments

`deep`

  Whether to make a deep clone.

### Examples

    # Create an instance with default settings:
    mybiodb <- biodb::newInst()

    # Create a connector
    conn <- mybiodb$getFactory()$createConn('hmdb.metabolites')

    # Get an entry
     # Getting one entry requires the download of the whole database.
    e <- conn$getEntry('HMDB0000001')

    # Terminate instance.
    mybiodb$terminate()

[Package biodbHmdb version 1.0.3 Index]