sampleVarDesc

Class: bioma.ExpressionSet
Namespace: bioma

Retrieve or set sample variable descriptions in ExpressionSet object

Syntax

DSVarDescriptions = sampleVarDesc(ESObj)
NewESObj = sampleVarDesc(ESObj, NewDSVarDescriptions)


Description

DSVarDescriptions = sampleVarDesc(ESObj) returns a dataset array containing the sample variable names and descriptions from the MetaData object in an ExpressionSet object.

NewESObj = sampleVarDesc(ESObj, NewDSVarDescriptions) replaces the sample variable descriptions in ESObj, an ExpressionSet object, with NewDSVarDescriptions, and returns NewESObj, a new ExpressionSet object.

Input Arguments

ESObj

Object of the bioma.ExpressionSet class.

NewDSVarDescriptions

Descriptions of the sample variable names, specified by either of the following: A new dataset array containing the sample variable names and descriptions. In this dataset array, each row corresponds to a variable. The first column contains the variable name, and the second column (VariableDescription) contains a description of the variable. The row names (variable names) must match the row names (variable names) in DSVarDescriptions, the dataset array being replaced in the MetaData object in the ExpressionSet object, ESObj. Cell array of character vectors containing descriptions of the sample variables. The number of elements in VarDesc must equal the number of row names (variable names) in DSVarDescriptions, the dataset array being replaced in the MetaData object in the ExpressionSet object, ESObj.

Output Arguments

DSVarDescriptions	A dataset array containing the sample variable names and descriptions from the MetaData object of an ExpressionSet object. In this dataset array, each row corresponds to a variable. The first column contains the variable name, and the second column (VariableDescription) contains a description of the variable.
NewESObj	Object of the bioma.ExpressionSet class, returned after replacing the dataset array containing the sample variable descriptions.

Examples

Construct an ExpressionSet object, ESObj, as described in the Examples section of the bioma.ExpressionSet class reference page. Retrieve the sample variable descriptions in the ExpressionSet object:

% Retrieve the sample variable descriptions
SVarDescriptions = sampleVarDesc(ESObj)