sybilSBML (version 3.1.2)

getSBMLunitDefinitionsList: Get Unit Definitions List

Description

Retrieve list of unit definitions included in a SBML model

Usage

getSBMLunitDefinitionsList(sbmlm)

Arguments

sbmlm

An object of class '>sbmlPtr as returned by getSBMLmodel. This is basically a pointer to a SBML model.

Value

If the SBML model contains a listOfUnitDefinitions section, a list is returned:

definition_id

character vector containing the unit definition id's. If no id is given for a particular unit definition, the corresponding value is set to "no_id".

definition

a list containing the units.

kind

character vector containing the unit kind's involved as unit definitions. If no kind is given for a particular unit, the corresponding value is set to "no_kind".

scale

integer vector containing the scale. If no scale is given for a particular unit, the corresponding value is set to 0.

exponent

integer vector containing the exponent. If no exponent is given for a particular unit, the corresponding value is set to 1.

multiplier

numeric vector containing the multiplier. If no multiplier is given for a particular species, the corresponding value is set to 1.

If no unit is given for a particular unit definition, the corresponding value is set to NULL.

All list elements have the same length. If the SBML model does not contain a listOfUnitDefinitions section, NULL is returned.

References

Bornstein, B. J., Keating, S. M., Jouraku, A., and Hucka M. (2008) LibSBML: An API Library for SBML. Bioinformatics 24, 880--881.

See Also

getSBMLmodel, '>sbmlPtr