Биокласс сопоставления

Суперклассы: BioRead

Содержите последовательность, качество, выравнивание и данные об отображении

Описание

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

Создайте объект BioMap из данных о последовательности короткого чтения. Каждый элемент в объекте имеет последовательность, заголовок, качественный счет и информацию о выравнивании/отображении, сопоставленную с ним. Используйте свойства объектов и методы, чтобы исследовать, получить доступ, отфильтровать, и управлять всеми или подмножеством данных, прежде, чем анализировать или просмотреть данные.

Конструкция

BioMapobj = BioMap BioMapobj построений, который является пустым объектом BioMap.

BioMapobj = BioMap(File) BioMapobj построений, объект BioMap, от File, SAM-или отформатированного BAM файла, чтения которого упорядочены положением запуска в ссылочной последовательности. Данные остаются в исходном файле и доступах к объекту BioMap это с помощью одного или двух вспомогательных индексных файлов. Для SAM-отформатированного файла MATLAB^® использует или создает один индексный файл, который должен иметь то же имя как исходный файл, но с расширением .idx. Для отформатированного BAM файла MATLAB использует или создает два индексных файла, которые должны иметь то же имя как исходный файл, но с расширениями *.linearindex и *.bai. Если индексные файлы не найдены в той же папке как исходный файл, функция конструктора BioMap создает индексные файлы в той папке.

Когда вы передаете в неупорядоченном отформатированном BAM файле, конструктор автоматически заказывает файл и пишет данные в упорядоченный файл с помощью того же базового имени и расширения с добавленным вектором символов “.ordered” перед расширением. Новый файл индексируется и используется, чтобы инстанцировать нового объекта BioMap.

Примечание

Поскольку данные остаются в исходном файле и получены доступ с помощью индексных файлов:

Не удаляйте исходный файл (SAM или BAM).
Не удаляйте индексные файлы (*.idx, *.bai, или *.linearindex).
Вы не можете изменить свойства BioMapobj.

Совет

Чтобы определить количество ссылочных последовательностей, включенных в ваш исходный файл, используйте функция baminfo или saminfo. Используйте SAMtools, чтобы проверять, упорядочены ли чтения в вашем исходном файле положением в ссылочной последовательности, и также переупорядочить их, в случае необходимости.

BioMapobj = BioMap(Struct) построения BioMapobj, объект BioMap, от Struct, структура MATLAB, содержащая последовательность и информацию о выравнивании, такой, как возвращено samread или функцией bamread. Данные из Struct остаются в памяти, которая позволяет вам изменить свойства BioMapobj.

BioMapobj = BioMap(___,'Name',Value) создает объект BioMap с помощью любого из предыдущих входных параметров и дополнительных опций, заданных как аргументы пары "имя-значение" можно следующим образом.

BioMapobj = BioMap(___,'SelectReference',SelectRefValue) выбирает одну или несколько ссылок, когда исходные данные содержат последовательности, сопоставленные больше чем с одной ссылкой. По умолчанию конструктор включает все ссылки в словаре заголовка исходного файла. Когда словарь заголовка не доступен, значения по умолчанию конструктора к включению всех ссылочных имен, найденных в исходных данных. SelectRefValue является вектором символов, строкой, вектором строки или массивом ячеек из символьных векторов. При помощи этой опции можно препятствовать тому, чтобы конструктор BioMap создал вспомогательные индексные файлы для ссылок, которые вы не будете использовать в своем анализе. Если какие-либо чтения, сопоставленные с выбранными ссылками, соединяются, и BioMapobj записан в файл, ссылочные последовательности помощников также включены в заголовок файла.

BioMapobj = BioMap(File,'InMemory',InMemoryValue) задает, поместить ли данные в память или оставить данные в исходном файле. Отъезд данных в исходном файле и доступ через индексный файл являются большей эффективной памятью, но не позволяют вам изменить свойства BioMapobj. Выбором является true или false (значение по умолчанию). Если первый входной параметр не является именем файла, то этот аргумент пары "имя-значение" проигнорирован, и данные автоматически помещаются в память.

Совет

Установите аргумент пары "имя-значение" 'InMemory' true, если вы хотите изменить свойства BioMapobj.

BioMapobj = BioMap(___,'IndexDir',IndexDirValue) задает путь к папке, где индексные файлы (*.idx, *.bai, или *.linearindex) или существуют или будут созданы.

Совет

Используйте аргумент пары "имя-значение" 'IndexDir', если у вас нет доступа для записи к папке, где исходный файл расположен.

BioMapobj = BioMap(___,'Sequence',SequenceValue) построения BioMapobj, объект BioMap, от SequenceValue, который содержит, он обозначает буквами представления последовательностей нуклеотида. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Header',HeaderValue) BioMapobj построений, объект BioMap, от HeaderValue, который содержит текст заголовка для последовательностей нуклеотида. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Quality',QualityValue) BioMapobj построений, объект BioMap, от QualityValue, который содержит представление ASCII качественной музыки на основу к последовательностям нуклеотида. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Reference',ReferenceValue) BioMapobj построений, объект BioMap и наборы свойство Reference к ReferenceValue, который содержит имена ссылочных последовательностей. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Signature',SignatureValue) BioMapobj построений, объект BioMap, от SignatureValue, который содержит информацию, описывающую выравнивание каждой последовательности чтения со ссылочной последовательностью. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Start',StartValue) BioMapobj построений, объект BioMap, от StartValue, вектора положительных целых чисел, задающих положение в ссылочной последовательности, где выравнивание каждой последовательности чтения запускается. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'Flag',FlagValue) построения BioMapobj, объект BioMap, от FlagValue, вектор положительных целых чисел, указывающих на поразрядную информацию для состояния 11 флагов, задан спецификацией формата SAM. Эти флаги описывают различные аспекты упорядочивания и выравнивания последовательностей чтения. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'MappingQuality',MappingQualityValue) построения BioMapobj, объект BioMap, от MappingQualityValue, вектора положительных целых чисел, задающих качество отображения для каждой последовательности чтения. Эта пара "имя-значение" работает, только если данные считаны в память.

BioMapobj = BioMap(___,'MatePosition',MatePositionValue) построения BioMapobj, объект BioMap, от MatePositionValue, вектора неотрицательных целых чисел, задающих положение помощника для каждой последовательности чтения. Эта пара "имя-значение" работает, только если данные считаны в память.

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

`File`	Вектор символов или строка, задающая SAM-или отформатированный BAM файл, который содержит только одну ссылочную последовательность и чьи чтения упорядочены положением запуска в ссылочной последовательности.
`Struct`	Структура MATLAB, содержащая последовательность и информацию о выравнивании, такой, как возвращено `samread` или функцией `bamread`. Структура должна иметь положение запуска на основе одно.
`SelectRefValue`	Вектор символов, строка, представляет в виде строки вектор или массив ячеек из символьных векторов, задающий имя ссылочных последовательностей в `File` или `Struct`. Используйте `saminfo` или `baminfo`, чтобы видеть полный список ссылочных последовательностей в `File`.
`InMemoryValue`	Логическое определение, поместить ли данные в память или оставить данные в исходном файле. Отъезд данных в исходном файле и доступ к нему через индексный файл являются большей эффективной памятью, но не позволяют вам изменить свойства объекта `BioMap`. Если первый входной параметр не является именем файла, то этот аргумент пары "имя-значение" проигнорирован, и данные автоматически помещаются в память. По умолчанию: false
`IndexDirValue`	Вектор символов или строка, задающая путь к папке, где индексный файл или существует или будет создан. Значение по умолчанию: Папка, где `File` расположен
`SequenceValue`	Вектор строки или массив ячеек из символьных векторов, содержащий представления буквы последовательностей нуклеотида. Эта информация заполняет свойство `Sequence` объекта `BioMap`. `samread` и функции `bamread` возвращают эту информацию в поле `Sequence` выходной структуры.
`QualityValue`	Вектор строки или массив ячеек из символьных векторов, содержащий представление ASCII качественной музыки на основу к последовательностям нуклеотида. Эта информация заполняет свойство `Quality` объекта `BioMap`. `samread` и функции `bamread` возвращают эту информацию в поле `Quality` выходной структуры.
`HeaderValue`	Вектор строки или массив ячеек из символьных векторов, содержащий текст заголовка для последовательностей нуклеотида. Эта информация заполняет свойство `Header` объекта `BioMap`. `samread` и функции `bamread` возвращают эту информацию в поле `QueryName` структуры возврата.
`NameValue`	Вектор символов или строка, описывающая объект `BioMap`. Эта информация заполняет свойство `Name` объекта. Значение по умолчанию: `' '`, пустой символьный вектор
`ReferenceValue`	Вектор строки или массив ячеек из символьных векторов, содержащий имена ссылочных последовательностей. Эта информация заполняет свойство `Reference` объекта. Функция `samread` возвращает эту информацию в поле `ReferenceName` выходного аргумента `SAMStruct`. Функция `bamread` возвращает эту информацию в поле `Reference` `HeaderStruct` структура вывода.
`SignatureValue`	Вектор строки или массив ячеек из символьных векторов, содержащий информацию, описывающую выравнивание каждой последовательности чтения со ссылочной последовательностью. `samread` и функции `bamread` возвращают эту информацию в поле `CigarString` структуры возврата. Эта информация заполняет свойство `Signature` объекта.
`StartValue`	Вектор положительных целых чисел, задающих положение в ссылочной последовательности, где выравнивание каждой последовательности чтения запускается. Эта информация заполняет свойство `Start` объекта. `samread` и функции `bamread` возвращают эту информацию в поле `Position` выходной структуры.
`FlagValue`	Вектор положительных целых чисел, указывающих на поразрядную информацию для состояния 11 флагов, задан спецификацией формата SAM. Эти флаги описывают различные аспекты упорядочивания и выравнивания последовательностей чтения. Эта информация заполняет свойство `Flag` объекта. `samread` и функции `bamread` возвращают эту информацию в поле `Flag` выходной структуры.
`MappingQualityValue`	Вектор положительных целых чисел, задающих качество отображения для каждой последовательности чтения. Эта информация заполняет свойство `MappingQuality` объекта. `samread` и функции `bamread` возвращают эту информацию в поле `MappingQuality` выходной структуры.
`MatePositionValue`	Вектор неотрицательных целых чисел, задающих положение помощника для каждой последовательности чтения. Эта информация заполняет свойство `MatePosition` объекта. `samread` и функции `bamread` возвращают эту информацию в поле `MatePosition` выходной структуры.

Свойства

`Flag`	Флаги, сопоставленные со всеми последовательностями чтения, представленными в объекте `BioMap`. Вектор положительных целых чисел, таким образом, что существует целое число для каждой последовательности чтения в объекте. Каждое целое число указывает на поразрядную информацию, которая задает состояние 11 флагов, описанных спецификацией формата SAM. Эти флаги описывают различные аспекты упорядочивания и выравнивания последовательности чтения. Непосредственное отношение существует между номером и порядком элементов в `Flag` и `Sequence`, если `Flag` не является пустым вектором.
`Header`	Заголовки, сопоставленные со всеми последовательностями чтения, представленными в объекте `BioMap`. Массив ячеек из символьных векторов, такой, что существует заголовок для каждой последовательности чтения в объекте. Заголовки могут быть пустыми. Непосредственное отношение существует между номером и порядком элементов в `Header` и `Sequence`, если `Header` не является массивом пустой ячейки.
`MatePosition`	Положения помощников для всех последовательностей чтения представлены в объекте `BioMap`. Вектор неотрицательных целых чисел, таким образом, что существует целое число для каждой последовательности чтения в объекте. Каждое целое число указывает на положение соответствующей последовательности помощника относительно ссылочной последовательности. Непосредственное отношение существует между номером и порядком элементов в `MatePosition` и `Sequence`, если `MatePosition` не является пустым вектором. Не все значения в векторе `MatePosition` представляют допустимые положения помощника, например, помощники, которые сопоставляют с различной ссылочной последовательностью или помощниками, которые не сопоставляют. Чтобы определить, допустимо ли положение помощника, используйте метод `filterByFlag` с флагом `'pairedInMap'`.
`MappingQuality`	Отображение качественных очков, сопоставленных со всеми последовательностями чтения, представленными в объекте `BioMap`. Вектор целых чисел, таких, что существует качественный счет отображения к каждой последовательности чтения в объекте. Непосредственное отношение существует между номером и порядком элементов в `MappingQuality` и `Sequence`, если `MappingQuality` не является пустым вектором.
`Name`	Описание объекта `BioMap`. Вектор символов, описывающий объект `BioMap`. Значение по умолчанию: `' '`, пустой символьный вектор
`NSeqs`	Количество последовательностей в объекте `BioMap`. Эта информация только для чтения.
`Quality`	Качественные очки на основу, сопоставленные со всеми последовательностями чтения, представленными в объекте `BioMap`. Массив ячеек из символьных векторов, такой, что существует качество для каждой последовательности чтения в объекте. Каждое качество является представлением ASCII качественной музыки на основу к последовательности чтения. Качество может быть пустым символьным вектором. Непосредственное отношение существует между номером и порядком элементов в `Quality` и `Sequence`, если `Quality` не является массивом пустой ячейки.
`Reference`	Ссылочные последовательности в объекте `BioMap`. `BioMapobj.NSeqs`-by-1 массив ячеек из символьных векторов, задающий имена ссылочных последовательностей. Ссылочные последовательности являются последовательностями, против которых выравниваются последовательности чтения.
`Sequence`	Считайте последовательности в объекте `BioMap`. Массив ячеек из символьных векторов, содержащий представления буквы последовательностей чтения.
`SequenceDictionary`	Массив ячеек из символьных векторов, который каталогизирует имена ссылок, доступных в объекте `BioMap`. Эта информация только для чтения.
`Signature`	Информация о выравнивании, сопоставленная со всеми последовательностями чтения, представленными в объекте `BioMap`. Массив ячеек отформатированных СИГАРОЙ векторов символов, таких, что существует информация о выравнивании для каждой последовательности чтения в объекте. Каждый вектор символов представляет, как последовательность чтения выравнивается к ссылочной последовательности. Подписи могут быть пустыми символьными векторами. Непосредственное отношение существует между номером и порядком элементов в `Signature` и `Sequence`, если `Signature` не является массивом пустой ячейки.
`Start`	Запустите положения всех выровненных последовательностей чтения, представленных в объекте `BioMap`. Вектор целых чисел, таких, что существует положение запуска для каждой последовательности чтения в объекте. Каждое целое число задает положение запуска выровненной последовательности чтения относительно чисел положения в ссылочной последовательности. Непосредственное отношение существует между номером и порядком элементов в `Start` и `Sequence`, если `Start` не является пустым вектором.

Методы

filterByFlag	Отфильтруйте чтения последовательности флагом SAM
getAlignment	Создайте выравнивание, представленное в объекте `BioMap`
getBaseCoverage	Возвратите покрытие выравнивания основы основой ссылочной последовательности в объекте `BioMap`
getCompactAlignment	Создайте компактное выравнивание, представленное в объекте `BioMap`
getCounts	Возвратите количество последовательностей чтения, выровненных к ссылочной последовательности в объекте `BioMap`
getFlag	Получите флаги последовательности чтения из объекта `BioMap`
getIndex	Возвратите индексы последовательностей чтения, выровненных к ссылочной последовательности в объекте `BioMap`
getInfo	Получите информацию для одного элемента объекта `BioMap`
getMappingQuality	Получите последовательность, сопоставляющую качественные очки от объекта `BioMap`
getMatePosition	Получите положения помощника последовательностей чтения от объекта `BioMap`
getReference	Получите ссылочную последовательность из объекта `BioMap`
getSignature	Получите подпись (информация о выравнивании) от объекта `BioMap`
getStart	Получите запускают положения выровненных последовательностей чтения от объекта `BioMap`
getStop	Вычислите положения остановки выровненных последовательностей чтения от объекта `BioMap`
getSummary	Распечатайте сводные данные объекта `BioMap`
setFlag	Установите флаги последовательности чтения для объекта `BioMap`
setMappingQuality	Установите последовательность, сопоставляющую качественную музыку к объекту `BioMap`
setMatePosition	Установите положения помощника последовательностей чтения в объекте `BioMap`
setReference	Определите имя ссылочной последовательности для объекта `BioMap`
setSignature	Установите подпись (информация о выравнивании) для объекта `BioMap`
setStart	Установите запускают положения выровненных последовательностей чтения в объекте `BioMap`

Унаследованные методы

объединение	Объедините два объекта
получение	Получите свойство объекта
getHeader	Получите заголовки последовательности из объекта
getQuality	Получите информацию о качестве последовательности из объекта
getSequence	Получите последовательности из объекта
getSubsequence	Получите частичные последовательности из объекта
getSubset	Получите подмножество элементов от объекта
plotSummary	Статистика краткого изложения сюжета данных NGS
набор	Установите свойство объекта
setHeader	Обновите информацию о заголовке чтений
setQuality	Обновите информацию о качестве
setSequence	Обновите последовательности чтения
setSubsequence	Обновите частичные последовательности
setSubset	Обновите элементы объекта
запись	Запишите содержимое объекта BioRead или BioMap зарегистрировать

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

Значение. Чтобы изучить, как классы значения влияют на операции копии, смотрите Копирование Объектов (MATLAB) в документации Основ программирования MATLAB.

Индексация

BioMap возражает точке поддержки. при индексации, чтобы извлечь, присвойте и удалите данные.

Примеры

свернуть все

Создайте объект BioMap

Скрипт Open Live Script

Этот пример показывает, как создать объект BioMap из файла SAM и из структуры.

Создайте объект BioMap из SAM-отформатированного файла, которому предоставляют Bioinformatics Toolbox™ и устанавливает свойство Name.

BMObj1 = BioMap('ex1.sam', 'Name', 'MyObject')

BMObj1 = 
  BioMap with properties:

    SequenceDictionary: 'seq1'
             Reference: [1501x1 File indexed property]
             Signature: [1501x1 File indexed property]
                 Start: [1501x1 File indexed property]
        MappingQuality: [1501x1 File indexed property]
                  Flag: [1501x1 File indexed property]
          MatePosition: [1501x1 File indexed property]
               Quality: [1501x1 File indexed property]
              Sequence: [1501x1 File indexed property]
                Header: [1501x1 File indexed property]
                 NSeqs: 1501
                  Name: 'MyObject'

Создайте структуру, содержащую информацию из файла SAM.

SAMStruct = samread('ex1.sam');

Создайте объект BioMap из этой структуры.

BMObj2 = BioMap(SAMStruct)

BMObj2 = 
  BioMap with properties:

    SequenceDictionary: {'seq1'}
             Reference: {1501x1 cell}
             Signature: {1501x1 cell}
                 Start: [1501x1 uint32]
        MappingQuality: [1501x1 uint8]
                  Flag: [1501x1 uint16]
          MatePosition: [1501x1 uint32]
               Quality: {1501x1 cell}
              Sequence: {1501x1 cell}
                Header: {1501x1 cell}
                 NSeqs: 1501
                  Name: ''

Темы

Управляйте последовательностью считанные данные в объектах

Документация

Биокласс сопоставления

Описание

Конструкция

Примечание

Совет

Совет

Совет

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

Свойства

Методы

Унаследованные методы

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

Индексация

Примеры

Создайте объект BioMap

Смотрите также

Темы

Внешние веб-сайты

Документация Bioinformatics Toolbox

Поддержка