elementNames

Class: bioma.ExpressionSet
Namespace: bioma

Retrieve or set element names of DataMatrix objects in ExpressionSet object

Syntax

ElmtNames = elementNames(ESObj)
ElmtNames = elementNames(ESObj, Subset)
NewESObj = elementNames(ESObj, Subset, NewElmtNames)

Description

ElmtNames = elementNames(ESObj) returns a cell array of character vectors specifying the element names of all the data elements (DataMatrix objects) stored in the ExptData object in an ExpressionSet object.

ElmtNames = elementNames(ESObj, Subset) returns a cell array of character vectors specifying the element names of a subset of the data elements (DataMatrix objects) in the ExptData object in an ExpressionSet object.

NewESObj = elementNames(ESObj, Subset, NewElmtNames) replaces the element names of the data elements (DataMatrix objects) specified by Subset in ESObj, an ExpressionSet object, with NewElmtNames, and returns NewESObj, a new ExpressionSet object.

Input Arguments

ESObj

Object of the bioma.ExpressionSet class.

Subset

One of the following to specify the element names of a subset of the data elements (DataMatrix objects) in the ExptData object of an ExpressionSet object:

  • Character vector or string specifying an element name

  • Cell array of character vectors or string vector specifying element names

  • Positive integer

  • Vector of positive integers

  • Logical vector

NewElmtNames

New element names for specific data elements (DataMatrix objects) within an ExpressionSet object, specified by one of the following:

  • Numeric vector

  • String vector, or cell array of character vectors

  • Character vector or string, which elementNames uses as a prefix for the element names, with element numbers appended to the prefix

  • Logical true or false (default). If true, elementNames assigns unique element names using the format Elmt1, Elmt2, etc.

The number of elements in NewElmtNames must equal the number of elements specified by Subset.

Output Arguments

ElmtNames

Cell array of character vectors specifying the element names of all or some of the data elements (DataMatrix objects) in the ExptData object of an ExpressionSet object.

NewESObj

Object of the bioma.ExpressionSet class, returned after replacing element names of specific data elements (DataMatrix objects).

Examples

Construct an ExpressionSet object, ESObj, as described in the Examples section of the bioma.ExpressionSet class reference page. Retrieve the element names of the DataMatrix objects in it:

% Retrieve element names of DataMatrix objects
ENames = elementNames(ESObj);

See Also

| | |

Topics