Bowtie2BuildOptions

Содержат опции для создания файлов индекса Bowtie 2 из ссылочных последовательностей

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

Описание

A Bowtie2BuildOptions объект содержит опции, чтобы запустить bowtie2build функция, которая создает файлы индекса Bowtie 2 из ссылки последовательностей.

Создание

Синтаксис

buildOptions = Bowtie2BuildOptions
buildOptions = Bowtie2BuildOptions(Name,Value)
buildOptions = Bowtie2BuildOptions(S)

Описание

пример

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

Bowtie2BuildOptions требуется интерфейс Bioinformatics Toolbox™ для Bowtie Aligner. Если этот пакет поддержки не установлен, то функция предоставляет ссылку на загрузку. Для получения дополнительной информации смотрите Пакеты поддержки ПО Bioinformatics Toolbox.

Примечание

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

пример

buildOptions = Bowtie2BuildOptions(Name,Value) устанавливает свойства с помощью одной или нескольких пар "имя-значение". Заключайте каждое имя свойства в кавычки. Для примера, buildOptions = Bowtie2BuildOptions('ForceLargeIndex',true) задает принудительное создание большого индекса, даже если ссылка имеет длину менее 4 миллиардов нуклеотидов.

пример

buildOptions = Bowtie2BuildOptions(S) задает необязательные параметры в векторе символов или строке S.

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

расширить все

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

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

Свойства

расширить все

Логический индикатор для создания только 3.bt2 и 4.bt2 файлы, которые соответствуют битовой версии ссылочных последовательностей, заданные как true или false.

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

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

Логический индикатор, опускающий построение 3.bt2 и 4.bt2 файлы, которые соответствуют битовой версии ссылочных последовательностей, заданные как true или false.

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

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

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

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

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

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

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

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

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

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

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

Количество строк Burrows-Wheeler, помечаемых при построении файлов индекса, заданное как положительное целое число. Чтобы сопоставить выравнивание с положениями на эталонных последовательностях, функция использует это число, чтобы отметить некоторые строки алгоритма Burrows-Wheeler с их соответствующим местоположением в геноме. Функция помечает каждые 2n, где n смещение.

Увеличение количества отмеченных строк ускоряет поиск положения ссылки, но требует большей памяти.

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

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

Число для установки seed в генераторе псевдослучайных чисел в виде неотрицательного целого числа.

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

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

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

getBowtie2CommandПереведите свойства объекта в опции Bowtie 2
getBowtie2TableИзвлечение таблицы со свойствами объекта и эквивалентными опциями Bowtie 2
runСоздайте файлы индекса Bowtie 2

Примеры

свернуть все

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

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

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

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

Можно задать различные опции при помощи Bowtie2BuildOptions объект или путем передачи синтаксической строки Bowtie 2. Например, можно задать, форсировать ли создание большого индекса, даже если ссылка составляет менее четырех миллиардов нуклеотидов, как показано ниже.

buildOpt = Bowtie2BuildOptions;

Установите ForceLargeIndex опция true.

buildOpt.ForceLargeIndex = true;

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

bowtie2build('Dmel_chr4.fa', 'Dmel_chr4_index_large',buildOpt);

Также можно передать синтаксическую строку Bowtie 2.

flag = bowtie2build('Dmel_chr4.fa', 'Dmel_chr4_index_large2','--large-index');

Ссылки

[1] Langmead, B., and S. Salzberg. «Быстрое выравнивание чтения с перерывами с Bowtie 2». Природные методы. 9, 2012, 357–359.

См. также

| | | |

Внешние веб-сайты

Введенный в R2018a

Документация по Bioinformatics Toolbox

Поддержка

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