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 - имя аргумента и 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.

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

Примеры

свернуть все

Открыть 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/BR2021ad/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

Поддержка

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