Annotated

Annotated

The Annotated class provides a store for arbitrary object-wide metadata. It is intended as a base class for other structures and should not be constructed directly.

Constructors of Annotated subclasses should be callable with no arguments, possibly creating an empty object with no properties. This will be used by the _bioconductor_CLONE method to return an instance of the subclass.

Constructor

new Annotated(metadata)

Source:
Parameters:
Name Type Description
metadata Object | Map | Array | List

Arbitrary list of metadata. An object/Map is converted to a named List, while an array is converted to an unnamed List.

Classes

Annotated

Methods

metadata() → {List}

Source:
Returns:

List of arbitrary metadata.

Type
List

setMetadata(value, optionsopt) → {Annotated}

Source:
Parameters:
Name Type Attributes Default Description
value Object | Map | Array | List

Object containing the metadata.
options Object <optional>
 {}

Optional parameters.

Properties
Name Type Attributes Default Description
inPlace boolean <optional>
 false

Whether to mutate this Annotated instance in place. If false, a new instance is returned.
Returns:

The Annotated object after replacing the metadata. If inPlace = true, this is a reference to the current instance, otherwise a new instance is created and returned.

Type
Annotated