Compartment-class {rsbml} | R Documentation

## SBML type "Compartment"

### Description

A bounded space that contains `Species`.

### Instantiation

Objects can be created by calls of the form `new("Compartment", ...)`.

### Slots

`id`:

  Object of class `"character"` uniquely identifying this component.

`name`:

  Object of class `"character"` naming this component.

`spatialDimensions`:

  Object of class `"integer"` indicating the number of dimensions (0, 1, 2, or 3)

`size`:

  Object of class `"numeric"` indicating the size in the given units.

`units`:

  Object of class `"character"` indicating the units (built-in or the id of a `UnitDefinition`).

`outside`:

  Object of class `"character"` identifying the compartment containing this compartment.

`constant`:

  Object of class `"logical"` indicating whether the size changes during simulation.

`metaId`:

  Object of class `"character"` that is an XML ID "described" by an RDF resource. This links an SBML element to an RDF resource. RDF may appear anywhere in an SBML element, but is usually placed inside the `annotation` element.

`notes`:

  Object of class `"character"` containing user-readable XHTML notes about an element.

`annotation`:

  Object of class `"character"` containing additional machine-readable information about an element, usually as RDF, such as BioPAX. This is where application-specific data belongs.

`cvTerms`:

  Object of class `"list"` containing instances of `CVTerm` associated with this element.

`sboTerm`:

  Object of class `"integer"` identifying a term in the Systems Biology Ontology (SBO).

### Extends

Class `"SBase"`, directly.

### Methods

id

  `signature(object = "Compartment")`: gets the `id` slot

id<-

  `signature(object = "Compartment")`: sets the `id` slot

name

  `signature(object = "Compartment")`: gets the `name` slot

name<-

  `signature(object = "Compartment")`: sets the `name` slot

constant

  `signature(object = "Compartment")`: gets the `constant` slot

constant<-

  `signature(object = "Compartment")`: sets the `constant` slot

outside

  `signature(object = "Compartment")`: gets the `outside` slot

outside<-

  `signature(object = "Compartment")`: sets the `outside` slot

size

  `signature(object = "Compartment")`: gets the `size` slot

size<-

  `signature(object = "Compartment")`: sets the `size` slot

units

  `signature(object = "Compartment")`: gets the `constant` slot

units<-

  `signature(object = "Compartment")`: sets the `constant` slot

spatialDimensions

  `signature(object = "Compartment")`: gets the `spatialDimensions` slot

spatialDimensions<-

  `signature(object = "Compartment")`: sets the `spatialDimensions` slot

### Author(s)

Michael Lawrence

### References

http://sbml.org/documents/

[Package rsbml version 2.48.0 Index]