BioMap class

Суперклассы: BioRead

Конструкция

BioMapobj = BioMap создает BioMapobj, который является пустым BioMap объект.

BioMapobj = BioMap(File) создает BioMapobj, а BioMap объект, из File, САМ- или BAM-форматированный файл, чтения которого упорядочены по начальной позиции в ссылочной последовательности. Данные остаются в исходном файле, и BioMap Объект обращается к нему с помощью одного или двух вспомогательных файлов индекса. Для файла в формате SAM, MATLAB^® использует или создает один индексный файл, который должен иметь то же имя, что и исходный файл, но с .idx расширение. Для файла в формате BAM MATLAB использует или создает два файла индекса, которые должны иметь то же имя, что и исходный файл, но с *.bai и *.linearindex расширения. Если файлы индекса не найдены в той же папке, что и исходный файл, BioMap Функция конструктора создает файлы индекса в этой папке.

Когда вы передаете в неупорядоченном BAM-форматированном файле, конструктор автоматически заказывает файл и записывает данные в упорядоченный файл с тем же базовым именем и расширением с добавленным символьным вектором. «упорядоченный» перед расширением. Новый файл индексируется и используется для создания экземпляров нового BioMap объект.

BioMapobj = BioMap(Struct) создает BioMapobj, а BioMap объект, из Struct, структуру MATLAB, содержащую информацию о последовательности и выравнивании, такую как возвращенная samread или bamread функция. Данные из Struct остается в памяти, что позволяет изменять BioMapobj свойства.

BioMapobj = BioMap(___,'Name',Value) создает BioMap объект использует любой из предыдущих входных параметров и дополнительные опции, заданные в виде аргументов пары "имя-значение" следующим образом.

BioMapobj = BioMap(___,'SelectReference',SelectRefValue) выбирает одну или несколько ссылок, когда исходные данные содержат последовательности, сопоставленные с несколькими ссылками. По умолчанию конструктор включает все ссылки в словарь заголовков исходного файла. Когда словарь заголовков недоступен, конструктор по умолчанию включает все имена ссылок, найденные в исходных данных. SelectRefValue - вектор символов, строка, строковый вектор или массив ячеек из векторов символов. При помощи этой опции можно предотвратить BioMap конструктор от создания вспомогательных файлов индексов для ссылок, которые вы не будете использовать в анализе. Если какие-либо чтения, сопоставленные с выбранными ссылками, являются парными и BioMapobj записывается в файл, ссылочные последовательности сопряженных также включаются в заголовок файла.

BioMapobj = BioMap(File,'InMemory',InMemoryValue) определяет, помещать ли данные в память или оставлять данные в исходном файле. Оставить данные в исходном файле и получить доступ через индекс файл более эффективно с точки зрения памяти, но не позволяет изменять свойства BioMapobj. Варианты true или false (по умолчанию). Если первый входной параметр не является именем файла, то этот аргумент пары "имя-значение" игнорируется, и данные автоматически помещаются в память.

BioMapobj = BioMap(___,'IndexDir',IndexDirValue) задает путь к папке, в которой находятся индексные файлы (*. idx, *. bai, или *. linearindex) существовать или будет создан.

BioMapobj = BioMap(___,'Sequence',SequenceValue) создает BioMapobj, а BioMap объект, из SequenceValue который содержит букву ему представления нуклеотидных последовательностей. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Header',HeaderValue) создает BioMapobj, а BioMap объект, из HeaderValue который содержит текст заголовка для нуклеотидных последовательностей. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Quality',QualityValue) создает BioMapobj, а BioMap объект, из QualityValue который содержит представление ASCII счетов качества по основаниям для нуклеотидных последовательностей. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Reference',ReferenceValue) создает BioMapobj, а BioMap объект, и устанавливает Reference свойство к ReferenceValue который содержит имена ссылочных последовательностей. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Signature',SignatureValue) создает BioMapobj, а BioMap объект, из SignatureValue который содержит информацию, описывающую выравнивание каждой последовательности чтения с ссылкой последовательностью. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Start',StartValue) создает BioMapobj, а BioMap объект, из StartValueвектор положительных целых чисел, задающий положение в ссылке последовательности, с которого начинается выравнивание каждой считанной последовательности. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'Flag',FlagValue) создает BioMapobj, а BioMap объект, из FlagValueвектор положительных целых чисел, указывающий битовую информацию для состояния 11 флагов, заданных спецификацией формата SAM. Эти флаги описывают различные аспекты секвенирования и выравнивания считанных последовательностей. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'MappingQuality',MappingQualityValue) создает BioMapobj, а BioMap объект, из MappingQualityValueвектор положительных целых чисел, задающий качество отображения для каждой последовательности чтения. Эта пара "имя-значение" работает только, если данные считываются в память.

BioMapobj = BioMap(___,'MatePosition',MatePositionValue) создает BioMapobj, а BioMap объект, из MatePositionValueвектор неотрицательных целых чисел, задающий положение совмещения для каждой считанной последовательности. Эта пара "имя-значение" работает только, если данные считываются в память.

BMObj1 = BioMap('ex1.sam', 'Name', 'MyObject')

BMObj1 = 
  BioMap with properties:

    SequenceDictionary: 'seq1'
             Reference: [1501x1 File indexed property]
             Signature: [1501x1 File indexed property]
                 Start: [1501x1 File indexed property]
        MappingQuality: [1501x1 File indexed property]
                  Flag: [1501x1 File indexed property]
          MatePosition: [1501x1 File indexed property]
               Quality: [1501x1 File indexed property]
              Sequence: [1501x1 File indexed property]
                Header: [1501x1 File indexed property]
                 NSeqs: 1501
                  Name: 'MyObject'

SAMStruct = samread('ex1.sam');

BMObj2 = BioMap(SAMStruct)

BMObj2 = 
  BioMap with properties:

    SequenceDictionary: {'seq1'}
             Reference: {1501x1 cell}
             Signature: {1501x1 cell}
                 Start: [1501x1 uint32]
        MappingQuality: [1501x1 uint8]
                  Flag: [1501x1 uint16]
          MatePosition: [1501x1 uint32]
               Quality: {1501x1 cell}
              Sequence: {1501x1 cell}
                Header: {1501x1 cell}
                 NSeqs: 1501
                  Name: ''