BioMap class

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

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

Описание

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

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

Конструкция

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

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

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

Примечание

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

  • Не удаляйте исходный файл (SAM или BAM).

  • Не удаляйте индексные файлы (*.idx, *.bai, или *.linearindex).

  • Вы не можете изменить BioMapobj свойства.

Совет

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

BioMapobj = BioMap(Struct) построения BioMapobjA 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) построения BioMapobjA BioMap объект, от SequenceValue это содержит, он обозначает буквами представления последовательностей нуклеотида. Эта пара "имя-значение" работает, только если данные считаны в память.

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

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

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

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

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

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

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

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

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

File

Вектор символов или строка, задающая SAM-или отформатированный BAM файл, который содержит только одну ссылочную последовательность и чьи чтения упорядочены положением запуска в ссылочной последовательности.

Struct

Структура MATLAB, содержащая последовательность и информацию о выравнивании, такой, как возвращено samread или bamread функция. Структура должна иметь положение запуска на основе одно.

SelectRefValue

Вектор символов, строка, представляет в виде строки вектор или массив ячеек из символьных векторов, задающий имя ссылочных последовательностей в File или StructИспользование saminfo или baminfo видеть полный список ссылочных последовательностей в File.

InMemoryValue

Логическое определение, поместить ли данные в память или оставить данные в исходном файле. Отъезд данных в исходном файле и доступ к нему через индексный файл используют память более эффективно, но не позволяют вам изменить свойства BioMap объект. Если первый входной параметр не является именем файла, то этот аргумент пары "имя-значение" проигнорирован, и данные автоматически помещаются в память.

По умолчанию: false

IndexDirValue

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

Значение по умолчанию: Папка, где File расположен

SequenceValue

Вектор строки или массив ячеек из символьных векторов, содержащий представления буквы последовательностей нуклеотида. Эта информация заполняет BioMap Sequence объекта свойство. samread и bamread функции возвращают эту информацию в Sequence поле структуры output.

QualityValue

Вектор строки или массив ячеек из символьных векторов, содержащий представление ASCII качественной музыки на основу к последовательностям нуклеотида. Эта информация заполняет BioMap Quality объекта свойство. samread и bamread функции возвращают эту информацию в Quality поле структуры output.

HeaderValue

Вектор строки или массив ячеек из символьных векторов, содержащий текст заголовка для последовательностей нуклеотида. Эта информация заполняет BioMap Header объекта свойство. samread и bamread функции возвращают эту информацию в QueryName поле структуры возврата.

NameValue

Вектор символов или строка, описывающая BioMap объект. Эта информация заполняет Name объекта свойство.

Значение по умолчанию: ' ', пустой символьный вектор

ReferenceValue

Вектор строки или массив ячеек из символьных векторов, содержащий имена ссылочных последовательностей. Эта информация заполняет Reference объекта свойство. samread функция возвращает эту информацию в ReferenceName поле SAMStruct выходной аргумент. bamread функция возвращает эту информацию в Reference поле HeaderStruct вывод структуры.

SignatureValue

Вектор строки или массив ячеек из символьных векторов, содержащий информацию, описывающую выравнивание каждой последовательности чтения со ссылочной последовательностью. samread и bamread функции возвращают эту информацию в CigarString поле структуры возврата. Эта информация заполняет Signature объекта свойство.

StartValue

Вектор из положительных целых чисел, задающих положение в ссылочной последовательности, где выравнивание каждой последовательности чтения запускается. Эта информация заполняет Start объекта свойство. samread и bamread функции возвращают эту информацию в Position поле структуры output.

FlagValue

Вектор из положительных целых чисел, указывающих на поразрядную информацию для состояния 11 флагов, задан спецификацией формата SAM. Эти флаги описывают различные аспекты секвенирования и выравнивания последовательностей чтения. Эта информация заполняет Flag объекта свойство. samread и bamread функции возвращают эту информацию в Flag поле структуры output.

MappingQualityValue

Вектор из положительных целых чисел, задающих качество отображения для каждой последовательности чтения. Эта информация заполняет MappingQuality объекта свойство. samread и bamread функции возвращают эту информацию в MappingQuality поле структуры output.

MatePositionValue

Вектор из неотрицательных целых чисел, задающих положение помощника для каждой последовательности чтения. Эта информация заполняет MatePosition объекта свойство. samread и bamread функции возвращают эту информацию в MatePosition поле структуры output.

Свойства

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- 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 объект

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

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

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

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

Индексация

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

Примеры

свернуть все

В этом примере показано, как создать объект 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: ''