describe {rsbml} | R Documentation

## Describing objects

### Description

Each class in the SBML DOM extends the `Describable` class and thus has a `describe` method, which describes an object with a short string. This is used by the `show` method to output terse textual representations of the DOM.

### Usage

      describe(object, ...)

### Arguments

`object` | The object to be described.
`...` | Additional arguments for methods.

### Value

A short textual (string) representation of `object`.

### Describable objects

An object that extends `Describable` has a method for the `describe` generic, and by default `Describable` objects are `show`n by printing the output of `describe`. Note that `Describable` is a virtual tag class, no objects may be created from it.

### Describable methods

show

  `signature(object = "Describable")`: outputs the return value of `describe`.

### Author(s)

Michael Lawrence

[Package rsbml version 2.42.0 Index]