BioMap class

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

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

Описание

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

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

Конструкция

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

BioMapobj = BioMap(File) построения BioMapobj, 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) построения 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`	Вектор строки или массив ячеек из символьных векторов, содержащий представления буквы последовательностей нуклеотида. Эта информация заполняет `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) в документации Основ программирования 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 class

Описание

Конструкция

Примечание

Совет

Совет

Совет

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

Свойства

Методы

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

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

Индексация

Примеры

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

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

Темы

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

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

Поддержка