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)