Bowtie2AlignOptions

Опции, чтобы сопоставить чтения со ссылочной последовательностью

Описание

Объект Bowtie2AlignOptions содержит опции, чтобы запустить функцию bowtie2, которая выравнивает чтения к ссылочной последовательности.

Создание

Синтаксис

alignOptions = Bowtie2AlignOptions
alignOptions = Bowtie2AlignOptions(Name,Value)
alignOptions = Bowtie2AlignOptions(S)

Описание

пример

alignOptions = Bowtie2AlignOptions создает объект Bowtie2AlignOptions со значениями свойств по умолчанию.

Bowtie2AlignOptions требует Интерфейса Bioinformatics Toolbox™ для пакета поддержки Выравнивателя Галстука-бабочки. Если этот пакет поддержки не установлен, то функция обеспечивает ссылку на загрузку.

Примечание

Bowtie2AlignOptions поддерживается на Mac и платформах UNIX® только.

пример

alignOptions = Bowtie2AlignOptions(Name,Value) свойства наборов с помощью одного или нескольких аргументов пары "имя-значение". Заключите каждое имя свойства в кавычки. Например, alignOptions = Bowtie2AlignOptions('Trim5',10) задает, чтобы обрезать 10 остатков от 5' концов.

пример

alignOptions = Bowtie2AlignOptions(S) задает дополнительные параметры в векторе символов S.

Входные параметры

развернуть все

Параметры выравнивания, заданные как вектор символов. S должен быть в Галстуке-бабочке 2 синтаксисами опции (снабженный префиксом одним или двумя тире) [1].

Свойства

развернуть все

Отметьте, чтобы позволить настройки ласточкиного хвоста, заданные как true или false. Это свойство задает, может ли выравнивание одного помощника расширить мимо начала выравнивания другого помощника и быть рассмотрено согласующееся.

Это свойство применяется к чтениям парного конца только.

Пример: 'AllowDovetail',true

Типы данных: логический

Штраф за положения с неоднозначными символами на последовательности чтения, ссылочной последовательности или обоих, заданных как неотрицательное целое число.

Пример: 'AmbiguousPenalty',2

Типы данных: double

Формат кодировки основного качества во входных файлах, заданных как одно из следующего: 'Phred33', 'Phred64' или 'Solexa'.

Пример: 'Encoding','Phred64'

Типы данных: char | string

Отметьте, чтобы позволить одному выравниванию помощника содержать выравнивание другого помощника и рассматриваться согласующимся, задаваться как true или false.

Это свойство применяется к чтениям парного конца только.

Пример: 'ExcludeContain',true

Типы данных: логический

Отметьте, чтобы включать противоречащие выравнивания, заданные как true или false. Противоречащее выравнивание является выравниванием, где оба помощника выравниваются исключительно, но не способом, который удовлетворяет ограничения парного конца.

Пример: 'ExcludeDiscordant',true

Типы данных: логический

Отметьте, чтобы исключить смешанные выравнивания, заданные как true или false. Смешанное выравнивание состоит из чтений помощника, которые не являются согласующимися или противоречащими, но выравниваются индивидуально.

Это свойство применяется к чтениям парного конца только.

Пример: 'ExcludeMixed',true

Типы данных: логический

Отметьте, чтобы позволить выравниванию одного помощника накладываться с выравниванием другого помощника и рассматриваться согласующимся, задаваться как true или false.

Пример: 'ExcludeOverlap',true

Типы данных: логический

Отметьте, чтобы исключить чтения, которым не удалось выровняться, заданный как true или false.

Пример: 'ExcludeUnaligned',true

Типы данных: логический

Дополнительные опции, не включенные в свойства объектов, заданные как вектор символов. Вектор символов должен быть в Галстуке-бабочке 2 синтаксисами опции (снабженный префиксом одним или двумя тире). Значение по умолчанию является пустым символьным вектором ''.

Пример: 'ExtraBowtie2Command','--version'

Типы данных: char | string

Отметьте, чтобы проигнорировать фактическое качество положения чтения, когда несоответствие произойдет, заданное как true или false. Установка этого свойства к true позволяет качественному значению в том несовпадающем положении быть максимально возможным, независимо от фактического значения.

Пример: 'IgnoreQuality',true

Типы данных: логический

Вознаграждение, добавленное к выравниванию, выигрывает, когда положение в чтении совпадает с положением в ссылке, заданной как неотрицательное целое число.

Пример: 'MatchBonus',5

Типы данных: double

Функция, управляющая максимальным количеством неоднозначных символов, позволенных в чтении, заданном как вектор символов или строка.

Функция имеет формат 'f,B,A', где f является функциональным типом, B является постоянным термином, и A является коэффициентом. Доступные функциональные типы:

  • C Постоянный

  • L Линейный

  • S Квадратный корень

  • G Естественный журнал

Получившейся функцией является H(x) = B + A * f(x), где x является продолжительностью чтения.

Функцией по умолчанию является 'L,0,0.15', то есть, H(x) = 0 + 0.15 * x.

Пример: 'MaxAmbiguousFunction','L,-0.4,-0.6'

Типы данных: char | string

Отметьте, чтобы использовать размещение в ОЗУ (вместо файлового ввода-вывода) при загрузке индекса, заданного как true или false. Размещение в ОЗУ позволяет многим параллельным процессам совместно использовать отображение памяти индекса, приводящего к более эффективному распараллеливанию задачи.

Пример: 'MemoryMappedIndex',true

Типы данных: логический

Функция, управляющая минимальным порогом счета выравнивания, заданного как вектор символов или строка.

Функция имеет формат 'f,B,A', где f является функциональным типом, B является постоянным термином, и A является коэффициентом. Доступные функциональные типы:

  • C Постоянный

  • L Линейный

  • S Квадратный корень

  • G Естественный журнал

Получившейся функцией является H(x) = B + A * f(x), где x является продолжительностью чтения.

Для режима выравнивания 'EndToEnd' функцией по умолчанию является 'L,-0.6,-0.6'. Для режима 'Local' функцией по умолчанию является 'G,20,8'.

Пример: 'MinScoreFunction','L,-0.4,-0.6'

Типы данных: char | string

Максимальные и минимальные значения, чтобы вычислить штраф несоответствия во время выравнивания, заданного как двухэлементный вектор. Первый элемент является максимальным значением, и второй элемент является минимальным значением.

Номер, меньше чем или равный максимальному значению и больше, чем или равный минимальному значению, вычтен из счета выравнивания к каждому положению, где символ чтения выравнивается к ссылочному символу, символы не соответствуют, и ни один не символ N.

Пример: 'MismatchPenalty',[5 3]

Типы данных: double

Режим Alignment, заданный как 'EndToEnd' или 'Local'.

В режиме 'Local' только часть чтения должна выровняться к ссылке, и некоторые остатки могут быть не использованы (мягко отсеченные), чтобы достигнуть лучшего счета выравнивания. В режиме 'EndToEnd' целое чтение должно выровняться без любого мягкого усечения.

Пример: 'Mode','Local'

Типы данных: char | string

Отметьте, чтобы повторно инициализировать псевдослучайный генератор для каждого чтения с помощью текущего времени, заданного как true или false. Если true, выравнивания, о которых сообщают для двух идентичных чтений, может отличаться. Значением по умолчанию является false, то есть, псевдослучайный генератор повторно инициализируется с помощью seed, выведенного от считанных информаций и номера seed.

Пример: 'Nondeterministic',true

Типы данных: логический

Количество положений вначале или конца каждого чтения, где разрывы не позволены, задало как неотрицательное целое число.

Пример: 'NoGapPositions',5

Типы данных: double

Максимальное количество допустимых выравниваний, чтобы сообщить прежде, чем отключить поиск, заданный как положительное целое число, 'Best' или 'All'. Если вы задаете положительный целочисленный N, функция ищет до N отличные, допустимые выравнивания для каждого чтения. 'Best' сообщает о лучшем выравнивании для каждого чтения. 'All' сообщает обо всех допустимых выравниваниях для каждого чтения, отсортированного по очкам выравнивания.

Счет выравнивания к выравниванию парного конца равняется сумме множества выравнивания отдельных помощников.

Пример: 'NumAlignments','All'

Типы данных: double | char | string

Максимальное количество пересева попыток с повторяющимися seed, заданными как неотрицательное целое число. Во время пересева функция выбирает новый набор чтений при различных смещениях, чтобы найти больше выравниваний.

Пример: 'NumReseedings',5

Типы данных: double

Максимальное количество последовательных попыток расширения seed прежде, чем получить новый seed, заданный как неотрицательное целое число. Расширение seed перестало работать, если оно не приводит к выравниванию с лучшим (или второсортный) счет.

Пример: 'NumSeedExtensions',10

Типы данных: double

Количество позволенных несоответствий в выравнивании seed во время выравнивания мультиseed, заданного как 0 или 1.

Пример: 'NumSeedMismatches',1

Типы данных: double

Количество параллельных потоков, чтобы выполнить выравнивание, заданное как положительное целое число. Потоки работают на отдельных процессорах или ядрах. Увеличение числа потоков обеспечивает значительное увеличение скорости (близко к линейному), но также и увеличивает объем потребляемой памяти.

Пример: 'NumThreads',4

Типы данных: double

Offrate, чтобы использовать при чтении индекса, чтобы уменьшать объем потребляемой памяти, заданный как положительное целое число. offrate должен быть больше, чем offrate раньше создавал индекс.

Пример: 'Offrate',20

Типы данных: double

Положение в ссылочной последовательности, где выравнивание для каждой последовательности начинается, заданный как неотрицательное целое число.

Пример: 'PadPositions',10

Типы данных: double

Разорвите затраты для открытия и расширения разрыва на чтении, заданном как двухэлементный вектор неотрицательных целых чисел. Первый элемент является стоимостью открытия разрыва, и второй элемент является стоимостью расширения разрыва. Учитывая вектор стоимости [GO GE] , разрыв чтения длины N присвоен штраф GO + N * GE.

Пример: 'ReadGapCosts',[4 2]

Типы данных: double

Считайте ID группы, чтобы прибавить строку заголовка @RG в отчете вывода SAM, заданном как вектор символов или строка. Если вы задаете какой-либо ID группы чтения, функция распечатывает строку заголовка @RG с тегом ID:, сопровождаемый заданным ID группы.

Пример: 'ReadGroupID','ID1'

Типы данных: char | string

Считайте информации группы, чтобы добавить как поле на строке заголовка @RG в отчете вывода SAM, заданном как вектор символов или строка. Это свойство применяется, только если вы задаете 'ReadGroupID'.

Пример: 'ReadGroup','Control'

Типы данных: char | string

Разорвите затраты для открытия и расширения разрыва на ссылке, заданной как двухэлементный вектор неотрицательных целых чисел. Первый элемент является стоимостью открытия разрыва, и второй элемент является стоимостью расширения разрыва. Учитывая вектор стоимости [GO GE] , ссылочный разрыв длины N присвоен штраф GO + N * GE.

Пример: 'RefGapCosts',[4 2]

Типы данных: double

Отметьте, чтобы переупорядочить записи SAM, чтобы поддержать тот же порядок как во входных файлах, заданных как true или false. Это свойство применяется только, когда количество параллельных потоков больше, чем один. Когда вы используете один поток, порядок записей в выводе совпадает с порядком входа.

Пример: 'Reorder',true

Типы данных: логический

Номер, чтобы установить seed в генераторе псевдослучайного числа, заданном как неотрицательное целое число.

Пример: 'Seed',3

Типы данных: double

Функция, управляющая расстоянием между подстроками seed во время выравнивания мультиseed, заданного как вектор символов или строка.

Функция имеет формат 'f,B,A', где f является функциональным типом, B является постоянным термином, и A является коэффициентом. Доступные функциональные типы:

  • C Постоянный

  • L Линейный

  • S Квадратный корень

  • G Естественный журнал

Получившейся функцией является H(x) = B + A * f(x), где x является продолжительностью чтения.

Для режима выравнивания 'EndToEnd' функцией по умолчанию является 'S,1,1.15'. Для режима 'Local' функцией по умолчанию является 'S,1,0.75'.

Пример: 'SeedIntervalFunction','S,2,2.15'

Типы данных: char | string

Отберите длину подстроки, чтобы выровняться во время выравнивания мультиseed, заданного как положительное целое число.

Пример: 'SeedLength',25

Типы данных: double

Количество чтений, чтобы проигнорировать с начала входных файлов, заданных как неотрицательное целое число.

Пример: 'Skip',5

Типы данных: double

Количество остатков, чтобы обрезать от 3' концов каждого чтения перед выравниванием, заданным как неотрицательное целое число.

Пример: 'Trim3',5

Типы данных: double

Количество остатков, чтобы обрезать от 5' концов каждого чтения перед выравниванием, заданным как неотрицательное целое число.

Пример: 'Trim5',5

Типы данных: double

Количество чтений, чтобы рассмотреть с начала входных файлов, заданных как положительное целое число. Значением по умолчанию является Inf, то есть, все чтения рассматриваются.

Пример: 'UpTo',1000

Типы данных: double

Функции объекта

getBowtie2CommandПереведите свойства объектов в Галстук-бабочку 2 опции
getBowtie2TableПолучите таблицу со свойствами объектов и эквивалентным Галстуком-бабочкой 2 опции
presetУстановите комбинацию опций выравнивания
runСопоставьте чтения последовательности со ссылочной последовательностью с помощью Галстука-бабочки 2

Примеры

свернуть все

Создайте набор индексных файлов для генома Дрозофилы. Сообщение об ошибке появляется, если у вас нет Интерфейса Bioinformatics Toolbox для пакета поддержки Выравнивателя Галстука-бабочки установленным, когда вы запускаете функцию. Щелкните по обеспеченной ссылке, чтобы загрузить пакет с меню Дополнения.

В данном примере ссылочной последовательности Dmel_chr4.fa уже предоставляют тулбокс.

status = bowtie2build('Dmel_chr4.fa', 'Dmel_chr4_index');

Если индексная сборка успешна, функция возвращает 0 и создает индексные файлы (*.bt2) в текущей папке. Файлы имеют префиксный 'Dmel_chr4_index'.

Иногда индексные файлы существуют, и вы хотите знать, что ссылочная последовательность раньше создавала индекс. В этом случае используйте функцию bowtie2inspect, чтобы получить больше информации о ссылке.

bowtie2inspect('Dmel_chr4', 'Dmel_chr4_retrieved.fa');

По умолчанию выходной файл Dmel_chr4_retrieved.fa содержит последовательность ссылки. Можно также получить итоговую информацию о ссылочном имени и длинах вместо фактической последовательности. Для получения дополнительной информации на доступных параметрах, смотрите Bowtie2InspectOptions.

Если индекс готов, сопоставьте последовательности чтения со ссылкой с помощью функции bowtie2. Парный конец считал файлы (SRR6008575_10k_1.fq, и SRR6008575_10k_2.fq) уже предоставлены тулбокс.

bowtie2('Dmel_chr4','SRR6008575_10k_1.fq','SRR6008575_10k_2.fq','SRR6008575_10k_chr4.sam');

Вывод является SAM-отформатированным файлом, который содержит результаты отображения.

Можно задать различные опции выравнивания путем передачи в Галстуке-бабочке 2 строк синтаксиса или использования объекта Bowtie2AlignOptions.

Предположим, что вы хотите обрезать некоторые остатки от конца 3' перед выравниванием. Во-первых, создайте объект Bowtie2AlignOptions.

 alignOpt = Bowtie2AlignOptions;

Обрежьте четыре остатка от конца 3' перед выравниванием.

 alignOpt.Trim3 = 4;

Сопоставьте чтения со ссылкой с помощью заданной опции выравнивания.

flag = bowtie2('Dmel_chr4','SRR6008575_10k_1.fq','SRR6008575_10k_2.fq','SRR6008575_10k_chr4_trimmed.sam',alignOpt);

Ссылки

[1] Langmead, B. и С. Залцберг. "Быстро содержащий разрывы считанное выравнивание с Галстуком-бабочкой 2". Методы природы. 9, 2012, 357–359.

Введенный в R2018a

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