getSBMLCompartList: Get Compartment List

In SysBioChalmers/sybil-SBML: 'SBML' Integration in Package 'Sybil'

Get Compartment List

Description

Retrieve list of compartments included in a SBML model

Usage

  getSBMLCompartList(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 ListOfCompartments section, a list is returned:

id	character vector containing the compartment id's. If no id is given for a particular compartment, the corresponding value is set to "no_id".
name	character vector containing the reaction names. If not available, the value is set to the empty string "".
outside	character vector containing the outside argument of the compartments. If not available, the value is set to the empty string "".

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

Author(s)

Gabriel Gelius-Dietrich <[e-mail]>

Maintainer: Mayo Roettger <[e-mail]>

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

SysBioChalmers/sybil-SBML documentation built on Aug. 24, 2023, 1:11 p.m.