exponenta event banner

saminfo

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

Синтаксис

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

Описание

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

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

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

File

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

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

Укажите дополнительные пары, разделенные запятыми Name,Value аргументы. Name является именем аргумента и Value - соответствующее значение. Name должен отображаться внутри кавычек. Можно указать несколько аргументов пары имен и значений в любом порядке как Name1,Value1,...,NameN,ValueN.

'NumOfReads'

Логический, который управляет включением NumReads поле в InfoStruct, структура вывода.

Примечание

Настройка NumOfReads кому true может значительно увеличить время создания структуры вывода.

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

'ScanDictionary'

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

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

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

InfoStruct

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

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

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

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

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

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

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

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

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

ReadGroup**

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

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

  • Образец

  • Библиотека

  • Описание

  • Блок платформы

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

  • Центр упорядочения

  • Дата

  • Платформа

Program**

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

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

  • Версия

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

* - NumReads пустое поле, если не установлен параметр NumOfReads аргумент пары имя-значение для true. ScannedDictionary и ScannedDictionaryCount пустые поля, если не установлен параметр ScanDictionary аргумент пары имя-значение для true.

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

Примеры

Вернуться к информации о ex1.sam файл, включенный в Toolbox™ биоинформатики:

info = saminfo('ex1.sam')
info = 

                  Filename: 'ex1.sam'
                  FilePath: [1x89 char]
                  FileSize: 254270
               FileModDate: '12-May-2011 14:23:25'
                    Header: [1x1 struct]
        SequenceDictionary: [1x1 struct]
                 ReadGroup: [1x2 struct]
                  NumReads: []
         ScannedDictionary: {0x1 cell}
    ScannedDictionaryCount: [0x1 uint64]

Вернуться к информации о ex1.sam файл, включающий число операций чтения:

info = saminfo('ex1.sam','numofreads', true)
info = 

                  Filename: 'ex1.sam'
                  FilePath: [1x89 char]
                  FileSize: 254270
               FileModDate: '12-May-2011 14:23:25'
                    Header: [1x1 struct]
        SequenceDictionary: [1x1 struct]
                 ReadGroup: [1x2 struct]
                  NumReads: 1501
         ScannedDictionary: {0x1 cell}
    ScannedDictionaryCount: [0x1 uint64]

Совет

Использовать saminfo чтобы исследовать размер и содержимое SAM-файла перед использованием samread для считывания содержимого файла в структуру MATLAB.
Представлен в R2010a