bioma.data.MetaData class

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

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

Описание

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

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

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

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

Класс 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) создает объект с помощью опций, заданных как имя свойства/property значением пар.

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-D графическую таблицу графического интерфейса пользователя значений переменных в объекте 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.'