Unit-class {rsbml} | R Documentation

## SBML type "Unit"

### Description

A (possibly transformed) reference to a base `UnitKind`. The transformation is of the form: $multiplier * 10^scale * x^exponent + offset$.

### Instantiation

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

### Slots

`kind`:
  Object of class `"character"` identifying a an SBML `UnitKind`. For possible values see Table 2 in the SBML specification.
`exponent`:
  Object of class `"integer"` indicating the exponent to use in the transformation.
`unitScale`:
  Object of class `"integer"` indicating the order of magnitude of the scaling to use in the transformation.
`multiplier`:
  Object of class `"numeric"` indicating the factor to use for scaling in the transformation.
`offset`:
  Object of class `"numeric"` indicating the amount of constant shift in the transformation.
`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

exponent
  `signature(object = "Unit")`: gets the `exponent` slot
exponent<-
  `signature(object = "Unit")`: sets the `exponent` slot
kind
  `signature(object = "Unit")`: gets the `kind` slot
kind<-
  `signature(object = "Unit")`: sets the `kind` slot
multiplier
  `signature(object = "Unit")`: gets the `multiplier` slot
multiplier<-
  `signature(object = "Unit")`: sets the `multiplier` slot
offset
  `signature(object = "Unit")`: gets the `offset` slot
offset<-
  `signature(object = "Unit")`: sets the `offset` slot
unitScale
  `signature(x = "Unit")`: ...
unitScale<-
  `signature(object = "Unit")`: sets the `unitScale` slot

### Author(s)

Michael Lawrence

### References

http://sbml.org/documents/

[Package rsbml version 1.6.0 Index]