baminfo

Возвратите информацию о файле BAM

свернуть все на странице

Синтаксис

InfoStruct = baminfo(File)
InfoStruct = baminfo(File,Name,Value)

Описание

InfoStruct = baminfo(File) возвращает структуру MATLAB®, содержащую итоговую информацию об отформатированном BAM файле.

InfoStruct = baminfo(File,Name,Value) возвращает структуру MATLAB с дополнительными опциями, заданными одним или несколькими аргументами пары Name,Value.

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

File

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

Аргументы в виде пар имя-значение

Укажите необязательные аргументы в виде пар ""имя, значение"", разделенных запятыми. Имя (Name) — это имя аргумента, а значение (Value) — соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

'ScanDictionary'

Логический, который управляет сканированием отформатированного BAM файла, чтобы определить ссылочные имена и количество чтений, выровненных к каждой ссылке. Если true, поля ScannedDictionary и ScannedDictionaryCount содержат эту информацию.

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

'NumOfReads'

Логический, который управляет сканированием отформатированного BAM файла, чтобы определить количество записей выравнивания в файле. Если true, поле NumReads содержит эту информацию.

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

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

InfoStruct

Структура MATLAB, содержащая итоговую информацию об отформатированном BAM файле. Структура содержит эти поля.

Поле Описание
FilenameИмя отформатированного BAM файла.
FilePathПуть к файлу.
FileSizeРазмер файла в байтах.
FileModDateДата модификации файла.
Header **Структура, содержащая версию формата файла, порядок сортировки и порядок группы.
ReadGroup **

Структура, содержащая:

  • Считайте идентификатор группы

  • Выборка

  • Библиотека

  • Описание

  • Модуль платформы

  • Предсказанный средний размер вставки

  • Упорядочивание центра

  • Дата

  • Платформа

SequenceDictionary **

Структура, содержащая:

  • Имя последовательности

  • Длина последовательности

  • Идентификатор блока генома

  • Контрольная сумма MD5 последовательности

  • URI последовательности

  • Разновидности

Program **

Структура, содержащая:

  • Название программы

  • Версия

  • Командная строка

NumReadsКоличество ссылочных последовательностей в отформатированном BAM файле.
ScannedDictionary *Массив ячеек из символьных векторов, задающий имена ссылочных последовательностей в отформатированном BAM файле.
ScannedDictionaryCount *Массив ячеек, задающий количество чтений, выровненных к каждой ссылочной последовательности.

Поля * — The ScannedDictionary и ScannedDictionaryCount пусты, если вы не устанавливаете аргумент пары "имя-значение" ScanDictionary true.

** — Эти структуры и их поля появляются в выходной структуре, только если они находятся в файле BAM. Информация в этих структурах зависит от информации в файле BAM.

Примеры

свернуть все

Скрипт Open Live Script

Этот пример показывает, как получить информацию о ex1.bam файле, включенном с Bioinformatics Toolbox™.

info = baminfo('ex1.bam','ScanDictionary',true,'numofreads',true)
info = struct with fields:
                  Filename: 'ex1.bam'
                  FilePath: '/mathworks/devel/bat/BR2019ad/build/matlab/toolbox/bioinfo/bioinfodata'
                  FileSize: 126692
               FileModDate: '07-May-2010 16:12:05'
                    Header: [1x1 struct]
                 ReadGroup: [1x2 struct]
        SequenceDictionary: [1x2 struct]
                  NumReads: 3307
         ScannedDictionary: {2x1 cell}
    ScannedDictionaryCount: [2x1 uint64]

Перечислите количество ссылок, найденных в файле BAM.

numel(info.ScannedDictionary)
ans = 2

Также можно использовать доступную информацию о заголовке из файла BAM, чтобы узнать количество ссылок, таким образом избегая целого обхода исходного файла.

info = baminfo('ex1.bam'); 
NRefs = numel(info.SequenceDictionary)
NRefs = 2

Советы

Используйте baminfo, чтобы исследовать размер и содержимое отформатированного BAM файла, включая ссылочные имена последовательности, перед использованием функции bamread, чтобы считать содержимое файла в структуру MATLAB.

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

|

Темы

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

Представленный в R2010b

Документация Bioinformatics Toolbox
Поддержка
Для просмотра документации необходимо авторизоваться на сайте