variableDesc

Класс: bioma.data.MetaData
Пакет: bioma.data

Извлеките или установите описания переменных для выборок в объекте MetaData

Синтаксис

DSVarDescriptions = variableDesc(MDObj)
NewMDObj = variableDesc(MDObj, NewDSVarDescriptions)

Описание

DSVarDescriptions = variableDesc(MDObj) возвращает массив набора данных, содержащий имена переменных и описания для выборок из объекта MetaData.

NewMDObj = variableDesc(MDObj, NewDSVarDescriptions) заменяет описание выборочной переменной в MDObj, объект MetaData с NewDSVarDescriptions, и возвращает NewMDObj, новый объект MetaData.

Входные параметры

MDObj

Объект bioma.data.MetaData класс.

NewDSVarDescriptions

Описания имен выборочных переменных, заданные одним из следующих:

  • Новый массив набора данных, содержащий имена переменных и описания для выборок. В этом массиве набора данных каждая строка соответствует переменной. Первый столбец содержит имя переменной и второй столбец (VariableDescription) содержит описание переменной. Имена строк (имена переменных) должны совпадать с именами строк (имена переменных) в DSVarDescriptions, массив набора данных, заменяемый в объекте MetaData, MDObj.

  • Массив ячеек из символьных векторов, содержащий описания переменных. Количество элементов в VarDesc должно равняться количеству имен строк (имен переменных) в DSVarDescriptions, массив набора данных, заменяемый в объекте MetaData, MDObj.

Выходные аргументы

DSVarDescriptions

Массив набора данных, содержащий имена переменных и описания из объекта MetaData. В этом массиве набора данных каждая строка соответствует переменной выборке. Первый столбец содержит имя переменной и второй столбец (VariableDescription) содержит описание переменной.

NewMDObj

Объект bioma.data.MetaData класс, возвращенный после замены массива набора данных, содержащего описание выборочной переменной.

Примеры

Создайте объект MetaData, а затем получите из него описание выборочных переменных:

% Import bioma.data package to make constructor function
% available
import bioma.data.*
% Construct MetaData object from .txt file
MDObj2 = MetaData('File', 'mouseSampleData.txt', 'VarDescChar', '#');
% Retrieve the sample variable descriptions
VarDescriptions = variableDesc(MDObj2)