exponenta event banner

bioma.data.MetaData класс

Пакет: bioma.data
Суперклассы:

Содержать метаданные из эксперимента с микрочипами

Описание

Класс MetaData предназначен для хранения метаданных (переменных значений и описаний) из эксперимента с микрочипами. Это удобный способ хранения связанных метаданных в одной структуре данных (объекте). Он также позволяет управлять данными и подбирать их.

Метаданные представляют собой набор имен переменных, например, связанных с образцами или элементами микрочипов, а также описания и значения переменных. Объект MetaData хранит метаданные в двух массивах наборов данных.

  • Массив наборов данных значений - массив наборов данных, содержащий измеренное значение каждой переменной на образец или элемент. В этом массиве наборов данных столбцы соответствуют переменным, а строки - образцам или элементам. Число и имена столбцов в этом массиве наборов данных должны совпадать с числом и именами строк в массиве наборов данных Описания. Если этот массив наборов данных содержит метаданные образца, то количество и имена строк (образцов) должны совпадать с числом и именами столбцов в объектах DataMatrix в одном объекте ExpressionSet. Если этот массив наборов данных содержит метаданные элемента, то количество и имена строк (элементов) должны совпадать с числом и именами строк в объектах DataMatrix в одном объекте ExpressionSet.

  • Массив наборов данных описаний - массив наборов данных, содержащий список имен переменных и их описаний. В этом массиве наборов данных каждая строка соответствует переменной. Имена строк - это имена переменных и столбцов с именами VariableDescription, содержит описание переменной. Число и имена строк в массиве наборов данных Descriptions должны совпадать с числом и именами столбцов в массиве наборов данных Values.

Класс MetaData включает свойства и методы, позволяющие получать, извлекать и изменять переменные метаданных, а также их значения и описания. Эти свойства и методы полезны для просмотра и анализа метаданных.

Строительство

MDobj = bioma.data.MetaData(VarValues) создает объект MetaData из одного массива наборов данных, строки которого соответствуют именам образцов (наблюдений) и столбцы которых соответствуют переменным. Массив наборов данных содержит измеренное значение каждой переменной на образец.

MDobj = bioma.data.MetaData(VarValues, VarDescriptions) создает объект MetaData из двух массивов наборов данных. VarDescriptions - массив наборов данных, строки которого соответствуют переменным. Имена строк - это имена переменных и другого столбца с именем VariableDescription, содержит описание каждой переменной.

MDobj = bioma.data.MetaData(VarValues, VarDesc) создает объект MetaData из массива набора данных и VarDesc массив ячеек символьных векторов, содержащих описания переменных.

MDobj = bioma.data.MetaData(..., 'PropertyName', PropertyValue) создает объект с помощью опций, указанных как пары имя/значение свойства.

MDobj = bioma.data.MetaData('File', FileValue) создает объект MetaData из текстового файла, содержащего таблицу метаданных. Метки строк таблицы должны быть именами образцов, а заголовки столбцов - именами переменных.

MDobj = bioma.data.MetaData('File', FileValue, ...'Path', PathValue) указывает папку или путь и папку, где FileValue хранится.

MDobj = bioma.data.MetaData('File', FileValue, ...'Delimiter', DelimiterValue) задает символ разделителя для использования в качестве разделителя столбцов FileValue. По умолчанию: '\t'.

MDobj = bioma.data.MetaData('File', FileValue, ...'RowNames', RowNamesValue) задает имена строк (имена образцов) для объекта MetaData. Значение по умолчанию - это информация в первом столбце таблицы.

MDobj = bioma.data.MetaData('File', FileValue, ...'ColumnNames', ColumnNamesValue) указывает столбцы данных для чтения из таблицы. ColumnNamesValue - массив ячеек символьных векторов, задающих имена заголовков столбцов. По умолчанию считываются все столбцы данных из таблицы, если первая строка содержит заголовки столбцов.

MDobj = bioma.data.MetaData('File', FileValue, ...'VarDescChar', VarDescCharValue) указывает, что строки в таблице имеют префикс VarDescCharValue для чтения в виде описаний и использования при создании VarDescriptions массив наборов данных. По умолчанию bioma.data.MetaData не считывает информацию описания переменной и не создает массив наборов данных Descriptions. Эти строки с префиксами должны отображаться в верхней части файла перед таблицей значений метаданных.

MDobj = bioma.data.MetaData(...'Name', NameValue) задает имя объекта MetaData.

MDobj = bioma.data.MetaData('File', FileValue, ...'Description', DescriptionValue) задает описание объекта MetaData.

MDobj = bioma.data.MetaData('File', FileValue, ...'SampleNames', SampleNamesValue) задает имена образцов (имена строк) для объекта MetaData.

MDobj = bioma.data.MetaData('File', FileValue, ...'VariableNames', VariableNamesValue) задает имена переменных (имена столбцов) для объекта MetaData.

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

VarValues

Массив наборов данных, строки которого соответствуют именам образцов (наблюдений) и столбцы которых соответствуют переменным. Массив наборов данных содержит измеренное значение каждой переменной на образец или элемент.

Номер и имена столбцов в VarValues массив наборов данных должен соответствовать числу и именам строк в VarDescriptions массив наборов данных. Если VarValues содержит образцы метаданных, затем количество и имена строк (образцов) должны совпадать с числом и именами столбцов в объектах DataMatrix в одном объекте ExpressionSet. Если VarValues содержит метаданные элемента, затем число и имена строк (элементов) должны совпадать с числом и именами строк в объектах DataMatrix в одном объекте ExpressionSet.

VarDescriptions

Массив наборов данных, строки которого соответствуют переменным. Имена строк - это имена переменных и столбцов с именами VariableDescription, содержит описание переменной. Номер и имена строк в VarDescriptions массив наборов данных должен соответствовать числу и именам столбцов в VarValues массив наборов данных.

VarDesc

Массив ячеек символьных векторов, содержащих описания переменных. Количество элементов в VarDesc должно равняться количеству столбцов (имен переменных) в VarValues.

FileValue

Вектор символов, указывающий текстовый файл, содержащий таблицу метаданных. Метки строк таблицы должны быть именами образцов или элементов, а заголовки столбцов - именами переменных. Текстовый файл должен находиться в пути поиска MATLAB или в текущей папке (если не используется Path свойство).

PathValue

Вектор символов, указывающий папку или путь и папку, где FileValue хранится.

DelimiterValue

Символьный вектор, указывающий символ разделителя для использования в качестве разделителя столбцов FileValue. Типичные варианты:

  • ' '

  • '\t' (по умолчанию)

  • ','

  • ';'

  • '|'

RowNamesValue

Имена строк (примеры или имена элементов) для объекта MetaData, указанные одним из следующих параметров:

  • Массив ячеек символьных векторов

  • Одиночный номер, указывающий столбец таблицы, содержащей имена строк

  • Вектор символов, указывающий заголовок столбца таблицы, содержащей имена строк

При указании [] для RowNamesValue, то bioma.data.MetaData предоставляет нумерованные имена строк, начиная с 1.

По умолчанию: 1, которая указывает информацию в первом столбце таблицы

ColumnNamesValue

Массив ячеек символьных векторов, указывающих имена заголовков столбцов для указания столбцов данных, считываемых из таблицы. По умолчанию считываются все столбцы данных из таблицы, если первая строка содержит заголовки столбцов. Если в таблице нет заголовков столбцов, укажите [] для ColumnNamesValue для чтения всех столбцов данных и предоставления имен нумерованных столбцов, начиная с 1.

VarDescCharValue

Вектор символов, указывающий символ для префикса строк в таблице, которые должны считываться как описания и использоваться для создания VarDescriptions массив наборов данных. По умолчанию bioma.data.MetaData не считывает информацию описания переменной и не создает VarDescriptions массив наборов данных. Эти строки с префиксами должны отображаться в верхней части файла перед таблицей значений метаданных.

NameValue

Вектор символов, указывающий имя объекта MetaData.

DescriptionValue

Символьный вектор, задающий описание объекта MetaData.

SampleNamesValue

Массив ячеек символьных векторов, задающих имена образцов для объекта MetaData. Количество элементов в массиве ячеек должно быть равно количеству выборок в объекте MetaData. Эти входные данные заменяют имена образцов из входного файла. По умолчанию используются имена образцов (имена строк) из входного файла.

VariableNamesValue

Массив ячеек символьных векторов, задающих имена переменных для объекта MetaData. Количество элементов в массиве ячеек должно быть равно количеству переменных в объекте MetaData. Эти входные данные заменяют имена переменных из входного файла. По умолчанию используются имена переменных (имена столбцов) из входного файла.

Свойства

Description

Описание объекта MetaData.

Символьный вектор, задающий описание объекта MetaData. По умолчанию: [].

DimensionLabels

Метки строк и столбцов для объекта MetaData.

Двухэлементный массив ячеек, содержащий векторы символов, определяющие метки строк и столбцов соответственно в объекте MetaData. По умолчанию: {'Samples', 'Variables'}.

Name

Имя объекта MetaData.

Вектор символов, указывающий имя объекта MetaData. По умолчанию: [].

NSamples

Количество образцов (наблюдений) в эксперименте

Положительное целое число, указывающее количество образцов в эксперименте. Это значение эквивалентно количеству строк в VarValues массив наборов данных. Эта информация доступна только для чтения

Атрибуты:

SetAccessprivate

NVariables

Количество переменных в эксперименте

Положительное целое число, указывающее количество переменных в эксперименте. Это значение эквивалентно количеству столбцов в VarValues массив наборов данных. Эта информация доступна только для чтения

Атрибуты:

SetAccessprivate

Методы

объединитьсяОбъединение двух объектов MetaData
isemptyОпределение пустого объекта MetaData
sampleNamesИзвлечение или установка имен образцов в объекте MetaData
размерВозвращаемый размер объекта MetaData
varValuesTableСоздайте 2-й графический графический интерфейс пользователя стола переменных ценностей в объекте MetaData
variableDescИзвлечение или установка описаний переменных для образцов в объекте MetaData
variableNamesИзвлечение или установка имен переменных для образцов в объекте MetaData
variableValuesИзвлечение или установка значений переменных для образцов в объекте MetaData

Иерархия экземпляров

Объект ExpressionSet содержит два объекта MetaData, один для информации о образцах и один для информации о свойствах микрочипов. Объект MetaData содержит два массива наборов данных. Один массив наборов данных содержит измеренное значение каждой переменной на образец или элемент. Другой массив наборов данных содержит список имен переменных и их описания.

Признаки

Сведения об атрибутах классов см. в разделе Атрибуты классов.

Копирование семантики

Значение. Сведения о том, как это влияет на использование класса, см. в разделе Копирование объектов.

Индексация

Объекты MetaData поддерживают индексирование 2-D скобками () и точками. индексирование для извлечения, назначения и удаления данных.

Объекты 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', '#');
% Display information about the MetaData object
MDObj2
% Supply a description for the MetaData object
MDObj2.Description = 'This MetaData Object contains sample variable info.'