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, а структура output.

Примечание

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

По умолчанию: 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. The ScannedDictionary и ScannedDictionaryCount поля пусты, если вы не устанавливаете ScanDictionary аргумент пары "имя-значение" в true.

** - Эти структуры и их поля появляются в структуру output только, если они находятся в файле 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

Поддержка

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