Exponenta 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 должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: 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 **

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

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

  • Версия

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

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

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

Примеры

Возвратите информацию о файле ex1.sam, включенном с Bioinformatics 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

Документация Bioinformatics Toolbox
Поддержка