Главная страница>Связанные с программированием>Другой исходный код
Скачать

Руководство пользователя Braker

Новости

Вот запись первой сессии мастерской BGA23 на Braker. Если обучение путем просмотра видео легко для вас, подумайте о том, чтобы просмотреть это: https://www.youtube.com/watch?v=UxtKJ4Mukyg

Braker3 сейчас в https://usegalaxy.eu/

Контакты для репозитория

Tsebra & Braker3 связаны:

  • Ларс Габриэль, Университет Грейфсвальда, Германия, [email protected]

Braker & Augustus связаны:

  • Катарина Дж. Хофф, Университет Грейфсвальда, Германия, [email protected], +49 3834 420 4624,

Genemark связан:

  • Марк Бородовский, Джорджия Тех, США, [email protected]

  • Томас Бруна, Совместный институт генома, США, [email protected]

  • Александр Ломсазде, Джорджия Тех, США, Александр[email protected]

Основные авторы Braker

[A] Университет Грейфсвальда, Институт математики и компьютерных наук, Walther-Rathenau-Str. 47, 17489 Грейфсвальд, Германия

[B] Университет Грейфсвальда, Центр функциональной геномики микробов, Феликс-Хаусдорфф-Стр. 8, 17489 Грейфсвальд, Германия

[C] Объединенное Университет Георгии Тех и Эмори Уоллес Х. Коултер Департамент биомедицинской инженерии, 30332 Атланта, США.

[D] Школа вычислительной науки и техники, 30332 Атланта, США.

[E] Московский институт физики и технологий, Московский регион 141701, Dolgoprudny, Россия

Braker2-Team-2 [Fig10]Braker2-Team-1 [Рис11]Braker2-Team-3 [Fig12]Braker2-Team-4 [Fig13]

Рисунок 1: Нынешние авторы, слева направо: Марио Стэнке, Александр Лосадзе, Катарина Дж. Хофф, Томас Бруна, Ларс Габриэль и Марк Бородовский. Мы признаем, что более крупное сообщество ученых внесло вклад в код Braker (например, через запросы на привлечение).

Финансирование

Развитие Braker1, Braker2 и Braker3 была поддержана Национальными институтами здравоохранения (NIH) [GM128145 до MB и MS]. Развитие Braker3 была частично финансирована за счет компетенции данных о проектах, предоставленной KJH и MS правительством Мекленбург-Ворпомонс, Германия.

Связанное программное обеспечение

Селектор стенограммы для Braker (Tsebra) доступен по адресу https://github.com/gaius-augustus/tsebra.

Genemark-ETP, один из искателей генов в основе Braker, доступен по адресу https://github.com/gatech-genemark/genemark-etp.

Август, второй ген-искатель в основе Braker, доступен по адресу https://github.com/gaius-augustus/augustus.

Galba, побочный эффект для использования Miniprot или Genomethreader для создания обучающих генов, доступен по адресу https://github.com/gaius-augustus/galba.

Содержимое

  • Авторы
  • Финансирование
  • Что такое Braker?
  • Ключи к успешному прогнозированию генов
  • Обзор режимов для запуска Braker
  • Контейнер
  • Установка
    • Поддерживаемые программные версии
    • Прозрачный
      • Зависимости от трубопровода Perl
      • Сочинения сорта
      • Биоинформатические программные зависимости
        • Обязательные инструменты
        • Обязательные инструменты для Braker3
        • Дополнительные инструменты
  • Бегущий сочетание
    • Режимы трубопровода изготовления
      • Braker с данными RNA-seq
      • Создатель с белковыми данными
      • Braker с данными РНК-seq и белка
      • Braker с коротким и длинным чтением РНК-seq и белком данных
    • Описание выбранных параметров командной строки Braker
      • -AB_INITIO
      • -augustus_args =-some_arg = bla
      • -threads = int
      • -Фунгус
      • -Useexisting
      • -CRF
      • -lambda = int
      • -utr = on
      • -addutr = on
      • -strande =+,-,., ...
      • [email protected]
      • -Busco_lineage Lineage
  • Вывод Braker
  • Пример данных
    • Описание данных
    • Тестирование Braker с данными RNA-seq
    • Тестирование Braker с белками
    • Тестирование Braker с белками и RNA-seq
    • Тестирование Braker с предварительно обученными параметрами
    • Тестирование Braker с последовательности генома
  • Начало Braker на основе ранее существующих пробежек Braker
  • Репортаж ошибок
    • Сообщение об ошибках на GitHub
    • Общие проблемы
  • Цитируя Braker и программное обеспечение под названием Braker
  • Лицензия

Что такое Braker?

Быстро растущее число секвенированных геномов требует полностью автоматизированных методов для точной аннотации структуры генов. Имея в виду эту цель, мы разработали Braker1 R1 R0 , комбинацию Genemark-ET R2 и Augustus R3, R4 , которая использует данные геномного и RNA-Seq для автоматического генерации полных аннотаций структуры генов в новом геноме.

Тем не менее, качество данных RNA-seq, которые доступны для аннотирования нового генома, является переменным, и в некоторых случаях данные RNA-seq вообще недоступны.

Braker2-это расширение Braker1, которое позволяет полностью автоматизировать обучение инструментов прогнозирования генов Genemark-ES/ET/EP/ETP R14, R15, R17, F1 и Augustus из информации о гомологии RNA-Seq и/или белках, которые интегрируют Внешние данные из информации о гомологии RNA-Seq и белков в прогнозирование .

В отличие от других доступных методов, которые полагаются на информацию о гомологии белков, Braker2 достигает высокой точности прогнозирования генов даже в отсутствие аннотации очень близкородственных видов и в отсутствие данных RNA-seq.

Braker3 - последний трубопровод в номере Braker. Это позволяет использовать данные РНК-seq и белка в полностью автоматизированном трубопроводе для обучения и прогнозирования высоко надежных генов с Genemark-ETP и Августом. Результатом трубопровода является комбинированный набор генов обоих инструментов прогнозирования генов, которые содержат только гены с очень высокой поддержкой из внешних данных.

В этом руководстве пользователя мы будем называть Braker1, Braker2 и Braker3 просто как Braker, потому что они выполняются одним и тем же сценарием ( braker.pl ).

Ключи к успешному прогнозированию генов

  • Используйте высококачественную сборку генома. Если у вас есть огромное количество очень коротких каркасов в вашей сборке генома, эти короткие каркасы, вероятно, значительно увеличатся, но не повысят точность прогноза.

  • Используйте простые имена каркасов в файле генома (например >contig1 будет работать лучше, чем >contig1my custom species namesome putative function /more/information/ and lots of special characters %&!*(){} ). Сделайте имена каркасов во всех ваших файлах FASTA простыми, прежде чем запустить любую программу выравнивания.

  • Чтобы точно предсказать гены в новом геноме, геном должен быть замаскирован для повторений. Это позволит избежать прогнозирования ложных положительных генных структур в повторяющихся и низких комплексных областях. Повторная маскировка также важна для картирования данных RNA-seq с геномом с некоторыми инструментами (другие пользователи RNA-seq, такие как HISAT2, игнорируют информацию о маскировании). В случае Genemark-ES/ET/EP/ETP и Augustus SoftMasking (то есть вмещает повторные области в буквы нижних регистра и все другие регионы в буквах верхнего регистра) приводит к лучшим результатам, чем хардмаски N для неизвестного нуклеотида).

  • Многие геномы имеют генные структуры, которые будут точно предсказаны со стандартными параметрами Genemark-ES/ET/EP/ETP и Августа в Braker. Тем не менее, некоторые геномы имеют специфичные для клады особенности, т.е. специальная модель филиала в грибах или нестандартные паттерны сплайсинга. Пожалуйста, прочитайте раздел «Параметры» [Параметры], чтобы определить, может ли какой -либо из пользовательских вариантов повысить точность прогнозирования генов в геноме вашего целевого вида.

  • Всегда проверяйте результаты прогнозирования генов перед дальнейшим использованием! Вы можете использовать браузер генома для визуального осмотра моделей генов в контексте с внешними данными данных. Braker поддерживает генерацию отслеживающих центров данных для браузера генома UCSC с Makehub для этой цели.

Обзор режимов для запуска Braker

Создание в основном показывает полузащиленные, внешние данные данных (РНК-seq и/или белковая информация о выравнивании сплайсинга) поддержала обучение Genemark-ES/ET/EP/ETP [F1] и последующее обучение Августа с интеграцией внешних данных в финале Шаг прогнозирования генов. Тем не менее, в настоящее время в Braker есть несколько дополнительных трубопроводов. Далее мы даем обзор возможных входных файлов и трубопроводов:

  • Файл генома, только. В этом режиме Genemark-ES обучается на одном последовательности генома. Длинные гены, предсказанные Genemark-ES, отобраны для обучения Августа. Окончательные прогнозы Августа являются ab initio . Этот подход, вероятно, даст более низкую точность прогноза, чем все остальные здесь, описанные трубопроводы. (См. Рисунок 2),

Braker2-Main-A [Figure]

Рисунок 2: Трубопровод Braker A: Обучение Genemark-ES только для данных генома,; AB initio гено

  • Геном и РНК-seq файл из одного и того же вида (см. Рисунок 3); Этот подход подходит для библиотек RNA-Seq с коротким чтением с хорошим освещением транскриптома, важно: этот подход требует, чтобы каждый интрон был покрыт многими выравниванием, то есть он не работает с собранными сопоставлениями транскриптома. В принципе, также выравнивания данных RNA-seq с длинным чтением могут привести к достаточным данным для запуска Braker, но только если каждая транскрипция, которая будет проходить обучение, была секвенирована и выровнен с геномом несколько раз. Имейте в виду, что в текущий момент Braker официально не поддерживает интеграцию данных RNA-seq с давним чтением.

Braker2-Main-B [Рис. 2]

Рисунок 3: Трубопровод Braker B: Обучение Genemark-ET поддерживается информацией о выравнивании RNA-seq, прогнозирование с Августом с той же сплайсированной информацией о выравнивании.

  • Файл генома и база данных белков, которые могут иметь неизвестное эволюционное расстояние до целевого вида (см. Рисунок 4); Этот подход особенно подходит, если данные РНК-seq не доступны. Этот метод будет работать лучше с белками от видов, которые довольно близки к целевым видам, но точность упадет лишь очень мало, если эталонные белки более отдаляются от целевых видов. Важно: этот подход требует базы данных семейств белков, то есть многие представители каждого семейства белков должны присутствовать в базе данных. Braker был успешно протестирован с Orthodb R19 . Prothint R18 Proteinploing Pipeline для создания необходимых подсказок для Braker доступен для загрузки по адресу https://github.com/gatech-genemark/prothint, программное обеспечение о том, как подготовить входные белки Orthodb, доступно на https: // github. com/tomasbruna/orthodb-clades. Вы можете добавить белки тесно связанного вида в файл OrthodB FASTA, чтобы включить дополнительные доказательства в прогнозирование генов. Мы предоставляем предварительно обработанную Orthodb v.11 Clades для загрузки по адресу https://bioinf.uni-greifswald.de/bioinf/partitioned_odb11/, и orthodb v.12 clades на https://bioinf.uni-greifswald.de/bioinf /partitioned_odb12/.

Braker2-Main-C [Figure]]

Рисунок 4: Трубопровод Craker C: Обучение Genemark-EP+ на выравнивании сплайсированного белка, начала и остановке, прогнозирование с Августом с той же информацией, кроме того, подсказки CDSpart. Используемые здесь белки могут быть любого эволюционного расстояния до целевого организма.

  • Файл генома и РНК-seq наборы (ы) от того же вида и белки, которые могут иметь неизвестное эволюционное расстояние до целевого вида (см. Рисунок 5); ВАЖНО: Этот подход требует базы данных семейств белков, то есть многие представители каждого семейства белков должны присутствовать в базе данных, например, Orthodb подходит. (Вы можете добавить белки тесно связанного вида в файл OrthodB FASTA, чтобы включить дополнительные доказательства в прогнозирование генов.)

Braker3-Main-A [Figure]]

Рисунок 5: Трубопровод Braker D: при необходимости, загрузка и выравнивание наборов RNA-seq для целевых видов. Обучение Genemark-ETP, поддерживаемое выравниванием РНК-seq и большой базой данных белков (белки могут иметь любое эволюционное расстояние). Впоследствии обучение и прогноз Августа с использованием той же внешней информации вместе с результатами GeneMark-ETP. Окончательным прогнозом является комбинация Цебра результатов Augustus и Genemark-ETP.

Контейнер

Мы знаем, что «ручная» установка Braker3 и все его зависимости утомительны и действительно сложны без разрешений на корень. Поэтому мы предоставляем контейнер Docker, который был разработан для управления сингулярностью. Вся информацию об этом контейнере можно найти по адресу https://hub.docker.com/r/teambraker/braker3

Короче говоря, создайте его следующим образом: 

 singularity build braker3.sif docker://teambraker/braker3:latest

Выполнять с: 

 singularity exec braker3.sif braker.pl

Тест с: 

 singularity exec -B $PWD:$PWD braker3.sif cp /opt/BRAKER/example/singularity-tests/test1.sh .
singularity exec -B $PWD:$PWD braker3.sif cp /opt/BRAKER/example/singularity-tests/test2.sh .
singularity exec -B $PWD:$PWD braker3.sif cp /opt/BRAKER/example/singularity-tests/test3.sh .
export BRAKER_SIF=/your/path/to/braker3.sif # may need to modify
bash test1.sh
bash test2.sh
bash test3.sh

Немногие пользователи хотят запустить свой анализ внутри Docker (поскольку требуются разрешения корневых). Однако, если это ваша цель, вы можете запустить и проверить контейнер следующим образом 

 sudo docker run --user 1000:100 --rm -it teambraker/braker3:latest bash
bash /opt/BRAKER/example/docker-tests/test1.sh # BRAKER1
bash /opt/BRAKER/example/docker-tests/test2.sh # BRAKER2
bash /opt/BRAKER/example/docker-tests/test3.sh # BRAKER3

️ Контейнер не включает в себя Java/Gushr/Story UTR, потому что в настоящее время мы не поддерживаем прогноз UTR с Braker. Это глюка и нестабильно. Не используйте его.

️ Пользователи сообщили, что вам необходимо вручную скопировать содержимое Augustus_config_path в место для записи, прежде чем запустить наши контейнеры из Nextflow. После этого вам необходимо указать записи, который можно записать Augustus_config_path в качестве аргумента командной строки для Braker в Nextflow.

Удачи ;-)

Установка

️ Предупреждение: если вы ранее использовали Braker1 и/или Braker2, имейте в виду, что использование изменилось в нескольких аспектах. Кроме того, более старые версии Genemark, которые задерживаются в вашей переменной $PATH могут привести к непредвиденным помехам, вызывая неудачи в программе. Пожалуйста, перемещайте все старые версии Genemark из вашего $PATH (например, Genemark в ProtHint/dependencies ).

Поддерживаемые программные версии

Во время выпуска эта версия Braker была протестирована с:

  • Август 3.5.0 F2

  • Genemark-ETP (источник см. Dockerfile)

  • Bamtools 2.5.1 R5

  • Samtools 1.7-4-G93586ED R6

  • Spaln 2.3.3d R8, R9, R10

  • NCBI Blast+ 2.2.31+ R12, R13

  • Алмаз 0,9,24

  • CDBFASTA 0,99

  • Cdbyank 0,981

  • Гушр 1.0.0

  • SRA Toolkit 3.00 R14

  • Hisat2 2.2.1 R15

  • BedTools 2.30 R16

  • Stringtie2 2.2.1 R17

  • Gffread 0,12,7 R18

  • Пополнение 0,2,5 R27

Прозрачный

Зависимости от трубопровода Perl

Запуск Braker требует Linux-систему с bash и Perl. Кроме того, Braker требует установки следующих модулей CPAN-PERL:

  • File::Spec::Functions

  • Hash::Merge

  • List::Util

  • MCE::Mutex

  • Module::Load::Conditional

  • Parallel::ForkManager

  • POSIX

  • Scalar::Util::Numeric

  • YAML

  • Math::Utils

  • File::HomeDir

Для GeneMark-ETP используется при подаче белка и RNA-seq:

  • YAML::XS
  • Data::Dumper
  • Thread::Queue
  • threads

Например, на Ubuntu установите модули с Cpanminus F4 : sudo cpanm Module::Name , например, sudo cpanm Hash::Merge .

Braker также использует модуль Perl helpMod_braker.pm , который недоступен на CPAN. Этот модуль является частью выпуска Braker и не требует отдельной установки.

Если у вас нет корневых разрешений на машине Linux, попробуйте настроить среду Anaconda (https://www.anaconda.com/distribution/) следующим образом: 

 wget https://repo.anaconda.com/archive/Anaconda3-2018.12-Linux-x86_64.sh
bash bin/Anaconda3-2018.12-Linux-x86_64.sh # do not install VS (needs root privileges)
conda install -c anaconda perl
conda install -c anaconda biopython
conda install -c bioconda perl-app-cpanminus
conda install -c bioconda perl-file-spec
conda install -c bioconda perl-hash-merge
conda install -c bioconda perl-list-util
conda install -c bioconda perl-module-load-conditional
conda install -c bioconda perl-posix
conda install -c bioconda perl-file-homedir
conda install -c bioconda perl-parallel-forkmanager
conda install -c bioconda perl-scalar-util-numeric
conda install -c bioconda perl-yaml
conda install -c bioconda perl-class-data-inheritable
conda install -c bioconda perl-exception-class
conda install -c bioconda perl-test-pod
conda install -c bioconda perl-file-which # skip if you are not comparing to reference annotation
conda install -c bioconda perl-mce
conda install -c bioconda perl-threaded
conda install -c bioconda perl-list-util
conda install -c bioconda perl-math-utils
conda install -c bioconda cdbtools
conda install -c eumetsat perl-yaml-xs
conda install -c bioconda perl-data-dumper

Впоследствии установите Braker и другое программное обеспечение «как обычно», находясь в вашей среде Conda. Примечание: есть пакет BioConda Braker и пакет BioConda Augustus. Они работают. Но они обычно отстают за кодом разработки обоих инструментов на GitHub. Поэтому мы рекомендуем ручную установку и использование последних источников.

Сочинения сорта

Braker - это коллекция сценариев Perl и Python и модуль Perl. Основной сценарий, который будет вызван для запуска Braker, - это braker.pl . Дополнительные компоненты Perl и Python:

  • align2hints.pl

  • filterGenemark.pl

  • filterIntronsFindStrand.pl

  • startAlign.pl

  • helpMod_braker.pm

  • findGenesInIntrons.pl

  • downsample_traingenes.pl

  • ensure_n_training_genes.py

  • get_gc_content.py

  • get_etp_hints.py

Все сценарии (файлы, заканчивающиеся *.pl и *.py ), которые являются частью Braker, должны быть исполняемыми, чтобы запустить Braker. Это уже должно быть так, если вы загружаете Braker из GitHub. Исполнительное средство может быть перезаписано, если вы, например, перенос Braker на USB-палке на другой компьютер. Чтобы проверить, являются ли необходимые файлы исполняемыми, запустите следующую команду в каталоге, который содержит сценарии Braker Perl: 

 ls -l *.pl *.py

Вывод должен быть похож на это: 

    -rwxr-xr-x 1 katharina katharina  18191 Mai  7 10:25 align2hints.pl
    -rwxr-xr-x 1 katharina katharina   6090 Feb 19 09:35 braker_cleanup.pl
    -rwxr-xr-x 1 katharina katharina 408782 Aug 17 18:24 braker.pl
    -rwxr-xr-x 1 katharina katharina   5024 Mai  7 10:25 downsample_traingenes.pl
    -rwxr-xr-x 1 katharina katharina   5024 Mai  7 10:23 ensure_n_training_genes.py
    -rwxr-xr-x 1 katharina katharina   4542 Apr  3  2019 filter_augustus_gff.pl
    -rwxr-xr-x 1 katharina katharina  30453 Mai  7 10:25 filterGenemark.pl
    -rwxr-xr-x 1 katharina katharina   5754 Mai  7 10:25 filterIntronsFindStrand.pl
    -rwxr-xr-x 1 katharina katharina   7765 Mai  7 10:25 findGenesInIntrons.pl
    -rwxr-xr-x 1 katharina katharina   1664 Feb 12  2019 gatech_pmp2hints.pl
    -rwxr-xr-x 1 katharina katharina   2250 Jan  9 13:55 log_reg_prothints.pl
    -rwxr-xr-x 1 katharina katharina   4679 Jan  9 13:55 merge_transcript_sets.pl
    -rwxr-xr-x 1 katharina katharina  41674 Mai  7 10:25 startAlign.pl

Важно, чтобы x in -rwxr-xr-x присутствовал для каждого сценария. Если это не так, запустите 

 `chmod a+x *.pl *.py`

Чтобы изменить атрибуты файла.

Вам может быть полезно добавить каталог, в котором сценарии Braker Perl находятся в вашей переменной среды $PATH . Для одного сеанса Bash, введите: 

    PATH=/your_path_to_braker/:$PATH
    export PATH

Чтобы сделать эту модификацию $PATH доступной для всех сеансов Bash, добавьте вышеупомянутые строки в сценарий запуска (например ~/.bashrc ).

Биоинформатические программные зависимости

Braker призывает различные программные инструменты для биоинформатики, которые не являются частью Braker. Некоторые инструменты обязательны, то есть Braker не будет работать вообще, если эти инструменты не присутствуют в вашей системе. Другие инструменты являются необязательными. Пожалуйста, установите все инструменты, которые необходимы для запуска Braker в режиме по вашему выбору.

Обязательные инструменты

Genemark-Etp

Скачать GeneMark-etp F1 с http://github.com/gatech-genemark/genemark-etp или https://topaz.gatech.edu/genemark/etp.for_braker.tar.gz. Распаковать и установить Genemark-ETP, как описано в файле README GeneMark-ETP.

Если уже содержится в вашей переменной $PATH , Braker автоматически угадает местоположение gmes_petap.pl или gmetp.pl . В противном случае, Braker может найти исполняемые файлы GeneMark-ES/ET/ETP либо, расположенные в их размещении в переменной среды GENEMARK_PATH , либо взяв аргумент командной строки ( --GENEMARK_PATH=/your_path_to_GeneMark_executables/ ).

Чтобы установить переменную среды для вашего текущего сеанса Bash, тип: 

 export GENEMARK_PATH=/your_path_to_GeneMark_executables/

Добавьте вышеупомянутые строки в сценарий запуска (например ~/.bashrc ), чтобы сделать их доступными для всех сеансов Bash.

Сценарии Perl в Genemark-ES/ET/EP/ETP настроены с местоположением Perl по умолчанию в /usr/bin/perl .

Если вы используете Genemark-ES/ET/EP/ETP в среде Anaconda (или хотите использовать Perl из переменной $PATH по любой другой причине), измените шебанг всех сценариев Genemark-ES/ET/EP/ETP с Следующая команда, расположенная внутри папки GeneMark-ES/ET/EP/ETP: 

 perl change_path_in_perl_scripts.pl "/usr/bin/env perl"

Вы можете проверить, правильно ли устанавливается Genemark-ES/ET/EP, запустив check_install.bash и/или выполняя примеры в каталоге GeneMark-E-tests .

Genemark-ETP совместим с нисходящим, то есть он охватывает функциональность Genemark-EP и Genemark-ET в Braker.

Август

Скачать Август из своего главного филиала по адресу https://github.com/gaius-augustus/augustus. Раскрыть Август и установить Август в соответствии с августами README.TXT . Не используйте устаревшие версии Августа из других источников, например, пакет Debian или пакет BioConda! Braker сильно зависит, в частности, от современного каталога Augustus/Scripts, а другие источники часто отстают.

Вы должны составить Август в своей собственной системе, чтобы избежать проблем с версиями библиотек, используемых Августом. Инструкции по компиляции приведены в файле Augustus README.TXT ( Augustus/README.txt ).

Август состоит из augustus , инструмента прогнозирования генов, дополнительных инструментов C ++, расположенных в Augustus/auxprogs и Perl сценариях, расположенных в Augustus/scripts . Сценарии Perl должны быть исполняемыми (см. Инструкции в компонентах Braker.

Инструмент C ++ bam2hints является важным компонентом Braker при запуске с RNA-seq. Источники расположены в Augustus/auxprogs/bam2hints . Убедитесь, что вы компилируете bam2hints в своей системе (она должна быть автоматически составлена, когда Август будет скомпилирован, но в случае проблем с bam2hints , пожалуйста, прочитайте инструкции по устранению неполадок в Augustus/auxprogs/bam2hints/README ).

Поскольку Braker - это трубопровод, который обучает Августа, IE записывает виды, конкретные файлы параметров, Braker нуждается в написании доступа к каталогу конфигурации Августа, который содержит такие файлы ( Augustus/config/ ). Если вы установите Augustus в глобальном уровне в свою систему, папка config , как правило, не подлежит записи всем пользователям. Либо сделайте каталог, в котором config проживает рекурсивно для записи для пользователей Августа, либо скопируйте config/ папку (рекурсивно) в место, где пользователи имеют разрешение на написание.

Август найдет папку config , ищет переменную среды $AUGUSTUS_CONFIG_PATH . Если переменная среды $AUGUSTUS_CONFIG_PATH не установлена, то Braker будет смотреть на путь ../config относительно каталога, в котором он находит исполняемого августа. В качестве альтернативы, вы можете предоставить переменную в качестве аргумента командной строки Braker ( --AUGUSTUS_CONFIG_PATH=/your_path_to_AUGUSTUS/Augustus/config/ ). Мы рекомендуем вам экспортировать переменную, например, для вашего текущего сеанса Bash: 

    export AUGUSTUS_CONFIG_PATH=/your_path_to_AUGUSTUS/Augustus/config/

Чтобы сделать переменную доступной для всех сеансов Bash, добавьте вышеупомянутую линию в сценарий запуска, например ~/.bashrc .

Пожалуйста, посмотрите на Dockerfile, если вы хотите установить Augustus в качестве пакета Debian. Таким образом, необходимо исправить ряд сценариев.

Важный:

Braker ожидает, что весь каталог config Августа по адресу $AUGUSTUS_CONFIG_PATH , т.е. species подпапок с его содержанием (по крайней мере, generic ) и extrinsic ! Предоставление записи, но пустой папки по адресу $AUGUSTUS_CONFIG_PATH не будет работать для Braker. Если вам нужно разделить бинар Augustus и $AUGUSTUS_CONFIG_PATH , мы рекомендуем вам рекурсивно скопировать содержимое незамеченного конфигурации в место для записи.

Если у вас есть общесистемная установка Augustus AT /usr/bin/augustus , нерапируемая копия config находится по адресу /usr/bin/augustus_config/ . Папка /home/yours/ можно записать вам. Скопируйте с помощью следующей команды (и дополнительно установите затем необходимые переменные): 

 cp -r /usr/bin/Augustus/config/ /home/yours/
export AUGUSTUS_CONFIG_PATH=/home/yours/augustus_config
export AUGUSTUS_BIN_PATH=/usr/bin
export AUGUSTUS_SCRIPTS_PATH=/usr/bin/augustus_scripts
Модификация $ path

Добавление каталогов Августа бинарных файлов и сценариев к вашей переменной $PATH позволяет вашей системе автоматически определять местонахождение этих инструментов. Это не требует от Braker для этого, потому что Braker попытается угадать их из местоположения другой переменной среды ( $AUGUSTUS_CONFIG_PATH ), или оба каталогов могут быть предоставлены в качестве аргументов командной строки для braker.pl , но мы рекомендуем для Добавьте их в свою переменную $PATH . Для вашего текущего сеанса Bash тип: 

    PATH=:/your_path_to_augustus/bin/:/your_path_to_augustus/scripts/:$PATH
    export PATH

Для всех ваших сеансов Bash добавьте вышеупомянутые строки в сценарий запуска (например ~/.bashrc ).

Python3

На Ubuntu Python3 обычно устанавливается по умолчанию, python3 будет в вашей переменной $PATH , по умолчанию, и Braker автоматически найдет его. Тем не менее, у вас есть возможность указать двоичное местоположение python3 двумя другими способами:

  1. Экспорт переменной среды $PYTHON3_PATH , например, в вашем файле ~/.bashrc : 

     export PYTHON3_PATH=/path/to/python3/

  2. Укажите опцию командной строки --PYTHON3_PATH=/path/to/python3/ to braker.pl .

Бамтул

Скачать Bamtools (например, git clone https://github.com/pezmaster31/bamtools.git ). Установите Bamtools, набрав следующее в своей оболочке: 

    cd your-bamtools-directory mkdir build cd build cmake .. make

Если уже в вашей переменной $PATH , Braker найдет Bamtools автоматически. В противном случае, Braker может найти Bamtools Binary либо с помощью переменной среды $BAMTOOLS_PATH , либо с помощью аргумента командной строки ( --BAMTOOLS_PATH=/your_path_to_bamtools/bin/ f6 ). Чтобы установить переменную среды, например, для вашего текущего сеанса Bash, тип: 

    export BAMTOOLS_PATH=/your_path_to_bamtools/bin/

Добавьте вышеупомянутую строку в сценарий запуска (например ~/.bashrc ), чтобы установить переменную среды для всех сеансов Bash.

NCBI Blast+ или Diamond

Вы можете использовать либо NCBI Blast+, либо Diamond для удаления избыточных тренировочных генов. Вам не нужны оба инструмента. Если алмаз присутствует, он будет предпочтительным, потому что он намного быстрее.

Получить и распаковать алмаз следующим образом: 

    wget http://github.com/bbuchfink/diamond/releases/download/v0.9.24/diamond-linux64.tar.gz
    tar xzf diamond-linux64.tar.gz

Если уже в вашей переменной $PATH , Braker найдет Diamond автоматически. В противном случае, Braker может найти Diamond Binary либо с помощью переменной среды $DIAMOND_PATH , либо принять аргумент командной строки ( --DIAMOND_PATH=/your_path_to_diamond ). Чтобы установить переменную среды, например, для вашего текущего сеанса Bash, тип: 

    export DIAMOND_PATH=/your_path_to_diamond/

Добавьте вышеупомянутую строку в сценарий запуска (например ~/.bashrc ), чтобы установить переменную среды для всех сеансов Bash.

Если вы решите для BLAST+, установите NCBI BLAST+ с sudo apt-get install ncbi-blast+ .

Если уже в вашей переменной $PATH , Braker найдет Blastp автоматически. В противном случае, Braker может найти двоичный файл Blastp, либо с помощью переменной среды $BLAST_PATH , либо с помощью аргумента командной строки ( --BLAST_PATH=/your_path_to_blast/ ). Чтобы установить переменную среды, например, для вашего текущего сеанса Bash, тип: 

    export BLAST_PATH=/your_path_to_blast/

Добавьте вышеупомянутую строку в сценарий запуска (например ~/.bashrc ), чтобы установить переменную среды для всех сеансов Bash.

Обязательные инструменты для Braker3

Genemark-ETP требуется следующие инструменты, и он попытается найти их в вашей переменной $PATH . Поэтому обязательно добавьте их местоположение в свой $PATH , например: 

 export PATH=$PATH:/your/path/to/Tool

Для всех инструментов ниже, добавьте вышеупомянутую строку в сценарий стартапа (например ~/.bashrc ), чтобы расширить переменную $PATH для всех сеансов Bash.

Эти программные инструменты являются обязательными только в том случае, если вы запускаете Braker с данными RNA-seq и белка!

Stringtie2

Stringtie2 используется Genemark-ETP для сборки выравнивающих выравниваний RNA-seq. Предварительную версию StringTie2 можно загрузить с https://ccb.jhu.edu/software/stringtie/#install.

Кровати

Программный пакет Bedtools требуется Genemark-ETP, если вы хотите запустить Braker с данными RNA-Seq и белка. Вы можете скачать Bedtools с https://github.com/arq5x/bedtools2/releases. Здесь вы можете загрузить предварительную версию bedtools.static.binary , например, 

 wget https://github.com/arq5x/bedtools2/releases/download/v2.30.0/bedtools.static.binary
mv bedtools.static.binary bedtools
chmod a+x

Или вы можете скачать bedtools-2.30.0.tar.gz и собрать его из источника, используя make , например, 

 wget https://github.com/arq5x/bedtools2/releases/download/v2.30.0/bedtools-2.30.0.tar.gz
tar -zxvf bedtools-2.30.0.tar.gz
cd bedtools2
make

См.

Gffread

Gffread-это коммунальное программное обеспечение, требуемое GeneMark-ETP. Его можно загрузить с https://github.com/gpertea/gffread/releases/download/v0.12.7/gffread-0.12.7.linux_x86_64.tar.gz и установлен с помощью make , Eg 

 wget https://github.com/gpertea/gffread/releases/download/v0.12.7/gffread-0.12.7.Linux_x86_64.tar.gz
tar xzf gffread-0.12.7.Linux_x86_64.tar.gz
cd gffread-0.12.7.Linux_x86_64
make

Дополнительные инструменты

Самтул

Samtools не требуется для запуска Braker без GeneMark-ETP, если все ваши файлы отформатированы, правильно (т.е. все последовательности должны иметь короткие и уникальные имена FASTA). Если вы не уверены, правильно ли разбужены ваши файлы, было бы полезно, чтобы Samtools установили, потому что Braker может автоматически решать определенные проблемы формата с помощью Samtools.

В качестве предпосылки для Samtools загружайте и установите htslib (например, git clone https://github.com/samtools/htslib.git , следуйте документации htslib для установки).

Загрузите и установите Samtools (например, git clone git://github.com/samtools/samtools.git ), впоследствии следуйте документации Samtools для установки).

Если уже в вашей переменной $PATH , Braker найдет Samtools автоматически. В противном случае, Braker может найти Samtools либо, взяв аргумент командной строки ( --SAMTOOLS_PATH=/your_path_to_samtools/ ), либо с помощью переменной среды $SAMTOOLS_PATH . Для экспорта переменной, например, для вашего текущего сеанса Bash, тип: 

    export SAMTOOLS_PATH=/your_path_to_samtools/

Добавьте вышеупомянутую строку в сценарий запуска (например ~/.bashrc ), чтобы установить переменную среды для всех сеансов Bash.

Биопитон

Если установлен BiopyThon, Braker может генерировать Fasta-Files с кодирующими последовательностями и белковыми последовательностями, предсказанными Августом, и генерировать отслеживание данных данных для визуализации пробега Braker с Makehub R16 . Это дополнительные шаги. Первый может быть отключен с помощью флага командной строки --skipGetAnnoFromFasta , второй можно активировать, используя параметры командной --makehub [email protected] , биопитон не требуется, если ни один из этих дополнительных шагов должен быть выполнен.

На Ubuntu установите Manager Python3 Package Manager с: 

 `sudo apt-get install python3-pip`

Затем установите BiopyThon с: 

 `sudo pip3 install biopython`

CDBFASTA

CDBFasta и CDBYANK требуются Braker для исправления генов Augustus с кодонами в рамке (сплайсированные стоп -кодоны) с использованием сценария Augustus fix_in_frame_stop_codon_genes.py. Это можно пропустить с помощью --skip_fixing_broken_genes .

На Ubuntu установите CDBFasta с: 

    sudo apt-get install cdbfasta

Для других систем вы можете, например, получить CDBFasta от https://github.com/gpertea/cdbfasta, например: 

    git clone https://github.com/gpertea/cdbfasta.git
    cd cdbfasta
    make all

На Ubuntu, CDBFasta и Cdbyank будут находиться в вашей переменной $PATH после установки, а Braker автоматически найдет их. Тем не менее, у вас есть возможность указать бинарное местоположение cdbfasta и cdbyank двумя другими способами:

  1. Экспорт переменной среды $CDBTOOLS_PATH , например, в вашем файле ~/.bashrc : 
    export CDBTOOLS_PATH=/path/to/cdbtools/
  1. Укажите опцию командной строки --CDBTOOLS_PATH=/path/to/cdbtools/ to braker.pl .

Спалн

ПРИМЕЧАНИЕ. Поддержка автономного спална (Ouside of Prothint) в Braker устарела.

Этот инструмент требуется, если вы запускаете Prothint или если вы хотите запустить белок до выравнивания генома с Braker, использующим Spaln за пределами Prothint. Использование Spaln за пределами Prothint является подходящим подходом, только если доступен аннотированный вид короткого эволюционного расстояния до вашего целевого генома. Мы рекомендуем запустить Spaln через Prothint для Braker. Prothint приносит вдоль бинарного сада. Если это не работает на вашей системе, загрузите Spaln с https://github.com/ogotoh/spaln. Распаковать и установить в соответствии с spaln/doc/SpalnReadMe22.pdf .

Braker попытается найти исполняемый файл SPALN, используя переменную среды $ALIGNMENT_TOOL_PATH . В качестве альтернативы, это может быть предоставлено в качестве аргумента командной строки ( --ALIGNMENT_TOOL_PATH=/your/path/to/spaln ).

Грушр

Этот инструмент требуется только в том случае, если вы хотите добавить UTRS (от данных RNA-seq) к прогнозируемым генам, либо если вы хотите обучить параметры UTR для Августа и предсказать гены с UTRS. В любом случае, Gushr требует ввода данных RNA-seq.

Gushr доступен для скачивания по адресу https://github.com/gaius-augustus/gushr. Получите его, набрав: 

 git clone https://github.com/Gaius-Augustus/GUSHR.git

Гушр выполняет файл JAR Gemoma R19, R20, R21 , и этот файл JAR требует Java 1.8. На Ubuntu вы можете установить Java 1.8 со следующей командой: 

 sudo apt-get install openjdk-8-jdk

Если в вашей системе установлено несколько версий Java, убедитесь, что вы включите 1,8 предшествующего запуска Braker с Java, выполняя работу. 

 sudo update-alternatives --config java

и выбрать правильную версию.

Инструменты из UCSC

Если вы переключитесь --UTR=on , bamtowig.py потребует следующих инструментов, которые можно загрузить с http://hgdownload.soe.ucsc.edu/admin/exe:

  • Twobitinfo

  • Fatotwobit

Необязательно установить эти инструменты в свой путь. Если вы этого не сделаете, и вы переключите --UTR=on , bamtowig.py автоматически загружает их в рабочий каталог.

Makehub

Если вы хотите автоматизировать, генерируйте центр данных вашего Braker Run, Makehub Software, доступное по адресу https://github.com/gaius-augustus/makehub. Загрузите программное обеспечение (запустив git clone https://github.com/Gaius-Augustus/MakeHub.git , либо выбирая релиз с https://github.com/gaius-augustus/makehub/releases. Извлечь релиз Пакет, если вы загрузили релиз (например, unzip MakeHub.zip или tar -zxvf MakeHub.tar.gz .

Braker попытается найти сценарий make_hub.py, используя переменную среды $MAKEHUB_PATH . В качестве альтернативы, это может быть предоставлено в качестве аргумента командной строки ( --MAKEHUB_PATH=/your/path/to/MakeHub/ ). Braker также может попытаться угадать местоположение Makehub в вашей системе.

SRA Toolkit

Если вы хотите, чтобы Braker загрузил библиотеки RNA-seq из SRA NCBI, требуется инструментарий SRA. Вы можете получить предварительную версию SRA Toolkit от http://daehwankimlab.github.io/hisat2/download/#version-hisat2-221.

Braker попытается найти исполняемые двоичные файлы из SRA Toolkit (FASTQ-DUMP, Prefetch), используя переменную среды $SRATOOLS_PATH . В качестве альтернативы, это может быть предоставлено в качестве аргумента командной строки ( --SRATOOLS_PATH=/your/path/to/SRAToolkit/ ). Braker также может попытаться угадать местоположение инструментария SRA в вашей системе, если исполняемые файлы находятся в вашей переменной $PATH .

Hisat2

Если вы хотите использовать невыполненные чтения RNA-seq, программное обеспечение HISAT2 необходимо для сопоставления их с геномом. Предварительная версия hisat2 может быть загружена с http://daehwankimlab.github.io/hisat2/download/#version-hisat2-221.

Braker попытается найти исполняемые двоичные файлы hisat2 (hisat2, hisat2-build), используя переменную среды $HISAT2_PATH . В качестве альтернативы, это может быть предоставлено в качестве аргумента командной строки ( --HISAT2_PATH=/your/path/to/HISAT2/ ). Braker также может попытаться угадать местоположение HISAT2 в вашей системе, если исполняемые файлы находятся в вашей переменной $PATH .

Пополнение

Если вы хотите запустить Tsebra в Braker в режиме максимизации полноты BUSCO, вам необходимо установить Common. 

 wget https://github.com/huangnengCSU/compleasm/releases/download/v0.2.4/compleasm-0.2.4_x64-linux.tar.bz2
tar -xvjf compleasm-0.2.4_x64-linux.tar.bz2 &&

Добавьте полученную папку Compliasm_kit в свою переменную $PATH , например: 

 export PATH=$PATH:/your/path/to/compleasm_kit

Commoncesm требует панд, которые можно установить с: 

 pip install pandas

Системные зависимости

Braker (braker.pl) использует GetConf, чтобы увидеть, сколько потоков можно запустить в вашей системе. На Ubuntu вы можете установить его с: 

 sudo apt-get install libc-bin

Бегущий сочетание

Разные режимы трубопровода Braker

Далее мы описываем «типичные» призывы Braker для различных типов входных данных. В целом, мы рекомендуем вам запустить Braker на геномных последовательностях, которые были сфальсифицированы для повторений. Braker следует применять только к геномам, которые были сфальсифицированы для повторений!

Braker с данными RNA-seq

This approach is suitable for genomes of species for which RNA-Seq libraries with good transcriptome coverage are available and for which protein data is not at hand. The pipeline is illustrated in Figure 2.

BRAKER has several ways to receive RNA-Seq data as input:

  • You can provide ID(s) of RNA-Seq libraries from SRA (in case of multiple IDs, separate them by comma) as argument to --rnaseq_sets_ids . The libraries belonging to the IDs are then downloaded automatically by BRAKER, eg: 

        braker.pl --species=yourSpecies --genome=genome.fasta 
       --rnaseq_sets_ids=SRA_ID1,SRA_ID2

  • You can use local FASTQ file(s) of unaligned reads as input. In this case, you have to provide BRAKER with the ID(s) of the RNA-Seq set(s) as argument to --rnaseq_sets_ids and the path(s) to the directories, where the FASTQ files are located as argument to --rnaseq_sets_dirs . For each ID ID , BRAKER will search in these directories for one FASTQ file named ID.fastq if the reads are unpaired, or for two FASTQ files named ID_1.fastq and ID_2.fastq if they are paired.

    For example, if you have a paired library called 'SRA_ID1' and an unpaired library named 'SRA_ID2', you have to have a directory /path/to/local/fastq/files/ , where the files SRA_ID1_1.fastq , SRA_ID1_2.fastq , and SRA_ID2.fastq reside. Then, you could run BRAKER with following command: 

        braker.pl --species=yourSpecies --genome=genome.fasta 
       --rnaseq_sets_ids=SRA_ID1,SRA_ID2 
       --rnaseq_sets_dirs=/path/to/local/fastq/files/

  • There are two ways of supplying BRAKER with RNA-Seq data as bam file(s). First, you can do it in the same way as you would supply FASTQ file(s): Provide the ID(s)/name(s) of your bam file(s) as argument to --rnaseq_sets_ids and specify directories where the bam files reside with --rnaseq_sets_dirs . BRAKER will automatically detect that these ID(s) are bam and not FASTQ file(s), eg: 

        braker.pl --species=yourSpecies --genome=genome.fasta 
       --rnaseq_sets_ids=BAM_ID1,BAM_ID2 
       --rnaseq_sets_dirs=/path/to/local/bam/files/

    Second, you can specify the paths to your bam file(s) directly, eg can either extract RNA-Seq spliced alignment information from bam files, or it can use such extracted information, directly. 

        braker.pl --species=yourSpecies --genome=genome.fasta 
       --bam=file1.bam,file2.bam

    Please note that we generally assume that bam files were generated with HiSat2 because that is the aligner that would also be executed by BRAKER3 with fastq input. If you want for some reason to generate the bam files with STAR, use the option --outSAMstrandField intronMotif of STAR to produce files that are compatible wiht StringTie in BRAKER3.

  • In order to run BRAKER with RNA-Seq spliced alignment information that has already been extracted, run: 

        braker.pl --species=yourSpecies --genome=genome.fasta 
       --hints=hints1.gff,hints2.gff

    The format of such a hints file must be as follows (tabulator separated file): 

        chrName b2h intron  6591    8003    1   +   .   pri=4;src=E
    chrName b2h intron  6136    9084    11  +   .   mult=11;pri=4;src=E
    ...

    The source b2h in the second column and the source tag src=E in the last column are essential for BRAKER to determine whether a hint has been generated from RNA-Seq data.

It is also possible to provide RNA-Seq sets in different ways for the same BRAKER run, any combination of above options is possible. It is not recommended to provide RNA-Seq data with --hints if you run BRAKER in ETPmode (RNA-Seq and protein data), because GeneMark-ETP won't use these hints!

BRAKER with protein data

This approach is suitable for genomes of species for which no RNA-Seq libraries are available. A large database of proteins (with possibly longer evolutionary distance to the target species) should be used in this case. This mode is illustrated in figure 9.

braker2-main-a

Figure 9: BRAKER with proteins of any evolutionary distance. ProtHint protein mapping pipelines is used to generate protein hints. ProtHint automatically determines which alignments are from close relatives, and which are from rather distant relatives.

For running BRAKER in this mode, type: 

 braker.pl --genome=genome.fa --prot_seq=proteins.fa

We recommend using OrthoDB as basis for proteins.fa . The instructions on how to prepare the input OrthoDB proteins are documented here: https://github.com/gatech-genemark/ProtHint#protein-database-preparation.

You can of course add additional protein sequences to that file, or try with a completely different database. Any database will need several representatives for each protein, though.

Instead of having BRAKER run ProtHint, you can also start BRAKER with hints already produced by ProtHint, by providing ProtHint's prothint_augustus.gff output: 

 braker.pl --genome=genome.fa --hints=prothint_augustus.gff

The format of prothint_augustus.gff in this mode looks like this: 

 2R ProtHint intron 11506230 11506648 4 + . src=M;mult=4;pri=4
2R ProtHint intron 9563406  9563473  1 + . grp=69004_0:001de1_702_g;src=C;pri=4;
2R ProtHint intron 8446312  8446371  1 + . grp=43151_0:001cae_473_g;src=C;pri=4;
2R ProtHint intron 8011796  8011865  2 - . src=P;mult=1;pri=4;al_score=0.12;
2R ProtHint start  234524   234526   1 + . src=P;mult=1;pri=4;al_score=0.08;

The prediction of all hints with src=M will be enforced. Hints with src=C are 'chained evidence', ie they will only be incorporated if all members of the group (grp=...) can be incorporated in a single transcript. All other hints have src=P in the last column. Supported features in column 3 are intron , start , stop and CDSpart .

Training and prediction of UTRs, integration of coverage information

If RNA-Seq (and only RNA-Seq) data is provided to BRAKER as a bam-file, and if the genome is softmasked for repeats, BRAKER can automatically train UTR parameters for AUGUSTUS. After successful training of UTR parameters, BRAKER will automatically predict genes including coverage information form RNA-Seq data. Example call: 

 braker.pl --species=yourSpecies --genome=genome.fasta 
   --bam=file.bam --UTR=on

Warnings:

  1. This feature is experimental!

  2. --UTR=on is currently not compatible with bamToWig.py as released in AUGUSTUS 3.3.3; it requires the current development code version from the github repository (git clone https://github.com/Gaius-Augustus/Augustus.git).

  3. --UTR=on increases memory consumption of AUGUSTUS. Carefully monitor jobs if your machine was close to maxing RAM without --UTR=on! Reducing the number of cores will also reduce RAM consumption.

  4. UTR prediction sometimes improves coding sequence prediction accuracy, but not always. If you try this feature, carefully compare results with and without UTR parameters, afterwards (eg in UCSC Genome Browser).

Stranded RNA-Seq alignments

For running BRAKER without UTR parameters, it is not very important whether RNA-Seq data was generated by a stranded protocol (because spliced alignments are 'artificially stranded' by checking the splice site pattern). However, for UTR training and prediction, stranded libraries may provide information that is valuable for BRAKER.

After alignment of the stranded RNA-Seq libraries, separate the resulting bam file entries into two files: one for plus strand mappings, one for minus strand mappings. Call BRAKER as follows: 

 braker.pl --species=yourSpecies --genome=genome.fasta 
    --bam=plus.bam,minus.bam --stranded=+,- 
    --UTR=on

You may additionally include bam files from unstranded libraries. Those files will not used for generating UTR training examples, but they will be included in the final gene prediction step as unstranded coverage information, example call: 

 braker.pl --species=yourSpecies --genome=genome.fasta 
   --bam=plus.bam,minus.bam,unstranded.bam 
   --stranded=+,-,. --UTR=on

Warning: This feature is experimental and currently has low priority on our maintenance list!

BRAKER with RNA-Seq and protein data

The native mode for running BRAKER with RNA-Seq and protein data. This will call GeneMark-ETP, which will use RNA-Seq and protein hints for training GeneMark-ETP. Subsequently, AUGUSTUS is trained on 'high-confindent' genes (genes with very high extrinsic evidence support) from the GeneMark-ETP prediction and a set of genes is predicted by AUGUSTUS. In a last step, the predictions of AUGUSTUS and GeneMark-ETP are combined using TSEBRA.

Alignment of RNA-Seq reads

GeneMark-ETP utilizes Stringtie2 to assemble RNA-Seq data, which requires that the aligned reads (BAM files) contain the XS (strand) tag for spliced reads. Therefore, if you align your reads with HISAT2, you must enable the --dta option, or if you use STAR, you must use the --outSAMstrandField intronMotif option. TopHat alignments include this tag by default.

To call the pipeline in this mode, you have to provide it with a protein database using --prot_seq (as described in BRAKER with protein data), and RNA-Seq data either by their SRA ID so that they are downloaded by BRAKER, as unaligned reads in FASTQ format, and/or as aligned reads in bam format (as described in BRAKER with RNA-Seq data). You could also specify already processed extrinsic evidence using the --hints option. However, this is not recommend for a normal BRAKER run in ETPmode, as these hints won't be used in the GeneMark-ETP step. Only use --hints when you want to skip the GenMark-ETP step!

Examples of how you could run BRAKER in ETPmode: 

    braker.pl --genome=genome.fa --prot_seq=orthodb.fa 
        --rnaseq_sets_ids=SRA_ID1,SRA_ID2 
        --rnaseq_sets_dirs=/path/to/local/RNA-Seq/files/

    braker.pl --genome=genome.fa --prot_seq=orthodb.fa 
        --rnaseq_sets_ids=SRA_ID1,SRA_ID2,SRA_ID3

        braker.pl --genome=genome.fa --prot_seq=orthodb.fa 
            --bam=/path/to/SRA_ID1.bam,/path/to/SRA_ID2.bam

BRAKER with short and long read RNA-Seq and protein data

A preliminary protocol for integration of assembled subreads from PacBio ccs sequencing in combination with short read Illumina RNA-Seq and protein database is described at https://github.com/Gaius-Augustus/BRAKER/blob/master/docs/long_reads/long_read_protocol.md

BRAKER with long read RNA-Seq (only) and protein data

We forked GeneMark-ETP and hard coded that StringTie will perform long read assembly in that particular version. If you want to use this 'fast-hack' version for BRAKER, you have to prepare the BAM file with long read to genome spliced alignments outside of BRAKER, eg: 

 T=48 # adapt to your number of threads
minimap2 -t${T} -ax splice:hq -uf genome.fa isoseq.fa > isoseq.sam     
samtools view -bS --threads ${T} isoseq.sam -o isoseq.bam

Pull the adapted container: 

 singularity build braker3_lr.sif docker://teambraker/braker3:isoseq

Calling BRAKER3 with a BAM file of spliced-aligned IsoSeq Reads: 

 singularity exec -B ${PWD}:${PWD} braker3_lr.sif braker.pl --genome=genome.fa --prot_seq=protein_db.fa –-bam=isoseq.bam --threads=${T}

Warning Do NOT mix short read and long read data in this BRAKER/GeneMark-ETP variant!

Warning The accuracy of gene prediction here heavily depends on the depth of your isoseq data. We verified with PacBio HiFi reads from 2022 that given sufficient completeness of the assembled transcriptome you will reach similar results as with short reads. However, we also observed a drop in accuracy compared to short reads when using other long read data sets with higher error rates and less sequencing depth.

Description of selected BRAKER command line options

Please run braker.pl --help to obtain a full list of options.

--ab_initio

Compute AUGUSTUS ab initio predictions in addition to AUGUSTUS predictions with hints (additional output files: augustus.ab_initio.* . This may be useful for estimating the quality of training gene parameters when inspecting predictions in a Browser.

--augustus_args="--some_arg=bla"

One or several command line arguments to be passed to AUGUSTUS, if several arguments are given, separate them by whitespace, ie "--first_arg=sth --second_arg=sth" . This may be be useful if you know that gene prediction in your particular species benefits from a particular AUGUSTUS argument during the prediction step.

--threads=INT

Specifies the maximum number of threads that can be used during computation. BRAKER has to run some steps on a single thread, others can take advantage of multiple threads. If you use more than 8 threads, this will not speed up all parallelized steps, in particular, the time consuming optimize_augustus.pl will not use more than 8 threads. However, if you don't mind some threads being idle, using more than 8 threads will speed up other steps.

--fungus

GeneMark-ETP option: run algorithm with branch point model. Use this option if you genome is a fungus.

--useexisting

Use the present config and parameter files if they exist for 'species'; will overwrite original parameters if BRAKER performs an AUGUSTUS training.

--crf

Execute CRF training for AUGUSTUS; resulting parameters are only kept for final predictions if they show higher accuracy than HMM parameters. This increases runtime!

--lambda=int

Change the parameter $lambda$ of the Poisson distribution that is used for downsampling training genes according to their number of introns (only genes with up to 5 introns are downsampled). Значение по умолчанию $lambda=2$ Полем You might want to set it to 0 for organisms that mainly have single-exon genes. (Generally, single-exon genes contribute less value to increasing AUGUSTUS parameters compared to genes with many exons.)

--UTR=on

Generate UTR training examples for AUGUSTUS from RNA-Seq coverage information, train AUGUSTUS UTR parameters and predict genes with AUGUSTUS and UTRs, including coverage information for RNA-Seq as evidence. This is an experimental feature!

If you performed a BRAKER run without --UTR=on, you can add UTR parameter training and gene prediction with UTR parameters (and only RNA-Seq hints) with the following command: 

 braker.pl --genome=../genome.fa --addUTR=on 
    --bam=../RNAseq.bam --workingdir=$wd 
    --AUGUSTUS_hints_preds=augustus.hints.gtf 
    --threads=8 --skipAllTraining --species=somespecies

Modify augustus.hints.gtf to point to the AUGUSTUS predictions with hints from previous BRAKER run; modify flaning_DNA value to the flanking region from the log file of your previous BRAKER run; modify some_new_working_directory to the location where BRAKER should store results of the additional BRAKER run; modify somespecies to the species name used in your previous BRAKER run.

--addUTR=on

Add UTRs from RNA-Seq converage information to AUGUSTUS gene predictions using GUSHR. No training of UTR parameters and no gene prediction with UTR parameters is performed.

If you performed a BRAKER run without --addUTR=on, you can add UTRs results of a previous BRAKER run with the following command: 

 braker.pl --genome=../genome.fa --addUTR=on 
    --bam=../RNAseq.bam --workingdir=$wd 
    --AUGUSTUS_hints_preds=augustus.hints.gtf --threads=8 
    --skipAllTraining --species=somespecies

Modify augustus.hints.gtf to point to the AUGUSTUS predictions with hints from previous BRAKER run; modify some_new_working_directory to the location where BRAKER should store results of the additional BRAKER run; this run will not modify AUGUSTUS parameters. We recommend that you specify the original species of the original run with --species=somespecies . Otherwise, BRAKER will create an unneeded species parameters directory Sp_* .

--stranded=+,-,.,...

If --UTR=on is enabled, strand-separated bam-files can be provided with --bam=plus.bam,minus.bam . In that case, --stranded=... should hold the strands of the bam files ( + for plus strand, - for minus strand, . for unstranded). Note that unstranded data will be used in the gene prediction step, only, if the parameter --stranded=... is set. This is an experimental feature! GUSHR currently does not take advantage of stranded data.

--makehub [email protected]

If --makehub and [email protected] (with your valid e-mail adress) are provided, a track data hub for visualizing results with the UCSC Genome Browser will be generated using MakeHub (https://github.com/Gaius-Augustus/MakeHub).

--gc_probability=DECIMAL

By default, GeneMark-ES/ET/EP/ETP uses a probability of 0.001 for predicting the donor splice site pattern GC (instead of GT). It may make sense to increase this value for species where this donor splice site is more common. For example, in the species Emiliania huxleyi , about 50% of donor splice sites have the pattern GC (https://media.nature.com/original/nature-assets/nature/journal/v499/n7457/extref/nature12221-s2.pdf, page 5).

--busco_lineage=lineage

Use a species-specific lineage, eg arthropoda_odb10 for an arthropod. BRAKER does not support auto-typing of the lineage.

Specifying a BUSCO-lineage invokes two changes in BRAKER R28 :

  1. BRAKER will run compleasm with the specified lineage in genome mode and convert the detected BUSCO matches into hints for AUGUSTUS. This may increase the number of BUSCOs in the augustus.hints.gtf file slightly.

  2. BRAKER will invoke best_by_compleasm.py to check whether the braker.gtf file that is by default generated by TSEBRA has the lowest amount of missing BUSCOs compared to the augustus.hints.gtf and the genemark.gtf file. If not, the following decision schema is applied to re-run TSEBRA to minimize the missing BUSCOs in the final output of BRAKER (always braker.gtf). If an alternative and better gene set is created, the original braker.gtf gene set is moved to a directory called braker_original. Information on what happened during the best_by_compleasm.py run is written to the file best_by_compleasm.log.

best_by_busco[fig14]

Please note that using BUSCO to assess the quality of a gene set, in particular when comparing BRAKER to other pipelines, does not make sense once you specified a BUSCO lineage. We recommend that you use other measures to assess the quality of your gene set, eg by comparing it to a reference gene set or running OMArk.

Output of BRAKER

BRAKER produces several important output files in the working directory.

  • braker.gtf: Final gene set of BRAKER. This file may contain different contents depending on how you called BRAKER

    • in ETPmode: Final gene set of BRAKER consisting of genes predicted by AUGUSTUS and GeneMark-ETP that were combined and filtered by TSEBRA.

    • otherwise: Union of augustus.hints.gtf and reliable GeneMark-ES/ET/EP predictions (genes fully supported by external evidence). In --esmode , this is the union of augustus.ab_initio.gtf and all GeneMark-ES genes. Thus, this set is generally more sensitive (more genes correctly predicted) and can be less specific (more false-positive predictions can be present). This output is not necessarily better than augustus.hints.gtf, and it is not recommended to use it if BRAKER was run in ESmode.

  • braker.codingseq: Final gene set with coding sequences in FASTA format

  • braker.aa: Final gene set with protein sequences in FASTA format

  • braker.gff3: Final gene set in gff3 format (only produced if the flag --gff3 was specified to BRAKER.

  • Augustus/*: Augustus gene set(s) in as gtf/conding/aa files

  • GeneMark-E*/genemark.gtf: Genes predicted by GeneMark-ES/ET/EP/EP+/ETP in GTF-format.

  • hintsfile.gff: The extrinsic evidence data extracted from RNAseq.bam and/or protein data.

  • braker_original/*: Genes predicted by BRAKER (TSEBRA merge) before compleasm was used to improve BUSCO completeness

  • bbc/*: output folder of best_by_compleasm.py script from TSEBRA that is used to improve BUSCO completeness in the final output of BRAKER

Output files may be present with the following name endings and formats:

  • Coding sequences in FASTA-format are produced if the flag --skipGetAnnoFromFasta was not set.

  • Protein sequence files in FASTA-format are produced if the flag --skipGetAnnoFromFasta was not set.

For details about gtf format, see http://www.sanger.ac.uk/Software/formats/GFF/. A GTF-format file contains one line per predicted exon. Пример: 

    HS04636 AUGUSTUS initial   966 1017 . + 0 transcript_id "g1.1"; gene_id "g1";
    HS04636 AUGUSTUS internal 1818 1934 . + 2 transcript_id "g1.1"; gene_id "g1";

The columns (fields) contain: 

    seqname source feature start end score strand frame transcript ID and gene ID

If the --makehub option was used and MakeHub is available on your system, a hub directory beginning with the name hub_ will be created. Copy this directory to a publicly accessible web server. A file hub.txt resides in the directory. Provide the link to that file to the UCSC Genome Browser for visualizing results.

Example data

An incomplete example data set is contained in the directory BRAKER/example . In order to complete the data set, please download the RNA-Seq alignment file (134 MB) with wget : 

 cd BRAKER/example
wget http://topaz.gatech.edu/GeneMark/Braker/RNAseq.bam

In case you have trouble accessing that file, there's also a copy available from another server: 

 cd BRAKER/example
wget http://bioinf.uni-greifswald.de/augustus/datasets/RNAseq.bam

The example data set was not compiled in order to achieve optimal prediction accuracy, but in order to quickly test pipeline components. The small subset of the genome used in these test examples is not long enough for BRAKER training to work well.

Data description

Data corresponds to the last 1,000,000 nucleotides of Arabidopsis thaliana 's chromosome Chr5, split into 8 artificial contigs.

RNA-Seq alignments were obtained by VARUS.

The protein sequences are a subset of OrthoDB v10 plants proteins.

List of files:

  • genome.fa - genome file in fasta format
  • RNAseq.bam - RNA-Seq alignment file in bam format (this file is not a part of this repository, it must be downloaded separately from http://topaz.gatech.edu/GeneMark/Braker/RNAseq.bam)
  • RNAseq.hints - RNA-Seq hints (can be used instead of RNAseq.bam as RNA-Seq input to BRAKER)
  • proteins.fa - protein sequences in fasta format

The below given commands assume that you configured all paths to tools by exporting bash variables or that you have the necessary tools in your $PATH.

The example data set also contains scripts tests/test*.sh that will execute below listed commands for testing BRAKER with the example data set. You find example results of AUGUSTUS and GeneMark-ES/ET/EP/ETP in the folder results/test* . Be aware that BRAKER contains several parts where random variables are used, ie results that you obtain when running the tests may not be exactly identical. To compare your test results with the reference ones, you can use the compare_intervals_exact.pl script as follows: 

 # Compare CDS features
compare_intervals_exact.pl --f1 augustus.hints.gtf --f2 ../../results/test${N}/augustus.hints.gtf --verbose
# Compare transcripts
compare_intervals_exact.pl --f1 augustus.hints.gtf --f2 ../../results/test${N}/augustus.hints.gtf --trans --verbose

Several tests use --gm_max_intergenic 10000 option to make the test runs faster. It is not recommended to use this option in real BRAKER runs, the speed increase achieved by adjusting this option is negligible on full-sized genomes.

We give runtime estimations derived from computing on Intel(R) Xeon(R) CPU E5530 @ 2.40GHz .

Testing BRAKER with RNA-Seq data

The following command will run the pipeline according to Figure 3: 

 braker.pl --genome genome.fa --bam RNAseq.bam --threads N --busco_lineage=lineage_odb10

This test is implemented in test1.sh , expected runtime is ~20 minutes.

Testing BRAKER with proteins

The following command will run the pipeline according to Figure 4: 

 braker.pl --genome genome.fa --prot_seq proteins.fa --threads N --busco_lineage=lineage_odb10

This test is implemented in test2.sh , expected runtime is ~20 minutes.

Testing BRAKER with proteins and RNA-Seq

The following command will run a pipeline that first trains GeneMark-ETP with protein and RNA-Seq hints and subsequently trains AUGUSTUS on the basis of GeneMark-ETP predictions. AUGUSTUS predictions are also performed with hints from both sources, see Figure 5.

Run with local RNA-Seq file: 

 braker.pl --genome genome.fa --prot_seq proteins.fa --bam ../RNAseq.bam --threads N --busco_lineage=lineage_odb10

This test is implemented in test3.sh , expected runtime is ~20 minutes.

Download RNA-Seq library from Sequence Read Archive (~1gb): 

 braker.pl --genome genome.fa --prot_seq proteins.fa --rnaseq_sets_ids ERR5767212 --threads N --busco_lineage=lineage_odb10

This test is implemented in test3_4.sh , expected runtime is ~35 minutes.

Testing BRAKER with pre-trained parameters

The training step of all pipelines can be skipped with the option --skipAllTraining . This means, only AUGUSTUS predictions will be performed, using pre-trained, already existing parameters. For example, you can predict genes with the command: 

    braker.pl --genome=genome.fa --bam RNAseq.bam --species=arabidopsis 
        --skipAllTraining --threads N

This test is implemented in test4.sh , expected runtime is ~1 minute.

Testing BRAKER with genome sequence

The following command will run the pipeline with no extrinsic evidence: 

 braker.pl --genome=genome.fa --esmode --threads N

This test is implemented in test5.sh , expected runtime is ~20 minutes.

Testing BRAKER with RNA-Seq data and --UTR=on

The following command will run BRAKER with training UTR parameters from RNA-Seq coverage data: 

 braker.pl --genome genome.fa --bam RNAseq.bam --UTR=on --threads N

This test is implemented in test6.sh , expected runtime is ~20 minutes.

Testing BRAKER with RNA-Seq data and --addUTR=on

The following command will add UTRs to augustus.hints.gtf from RNA-Seq coverage data: 

 braker.pl --genome genome.fa --bam RNAseq.bam --addUTR=on --threads N

This test is implemented in test7.sh , expected runtime is ~20 minutes.

Starting BRAKER on the basis of previously existing BRAKER runs

There is currently no clean way to restart a failed BRAKER run (after solving some problem). However, it is possible to start a new BRAKER run based on results from a previous run -- given that the old run produced the required intermediate results. We will in the following refer to the old working directory with variable ${BRAKER_OLD} , and to the new BRAKER working directory with ${BRAKER_NEW} . The file what-to-cite.txt will always only refer to the software that was actually called by a particular run. You might have to combine the contents of ${BRAKER_NEW}/what-to-cite.txt with ${BRAKER_OLD}/what-to-cite.txt for preparing a publication. The following figure illustrates at which points BRAKER run may be intercepted.

braker-intercept[fig8]

Figure 10: Points for intercepting a BRAKER run and reusing intermediate results in a new BRAKER run.

Option 1: starting BRAKER with existing hints file(s) before training

This option is only possible for BRAKER in ETmode or EPmode and нет in ETPmode!

If you have access to an existing BRAKER output that contains hintsfiles that were generated from extrinsic data, such as RNA-Seq or protein sequences, you can recycle these hints files in a new BRAKER run. Also, hints from a separate ProtHint run can be directly used in BRAKER.

The hints can be given to BRAKER with --hints ${BRAKER_OLD}/hintsfile.gff option. This is illustrated in the test files test1_restart1.sh , test2_restart1.sh , test4_restart1.sh . The other modes (for which this test is missing) cannot be restarted in this way.

Option 2: starting BRAKER after GeneMark-ES/ET/EP/ETP had finished, before training AUGUSTUS

The GeneMark result can be given to BRAKER with --geneMarkGtf ${BRAKER_OLD}/GeneMark*/genemark.gtf option if BRAKER is run in ETmode or EPmode. This is illustrated in the test files test1_restart2.sh , test2_restart2.sh , test5_restart2.sh .

In ETPmode, you can either provide BRAKER with the results of the GeneMarkETP step manually, with --geneMarkGtf ${BRAKER_OLD}/GeneMark-ETP/proteins.fa/genemark.gtf , --traingenes ${BRAKER_OLD}/GeneMark-ETP/training.gtf , and --hints ${BRAKER_OLD}/hintsfile.gff (see test3_restart1.sh for an example), or you can specify the previous GeneMark-ETP results with the option --gmetp_results_dir ${BRAKER_OLD}/GeneMark-ETP/ so that BRAKER can search for the files automatically (see test3_restart2.sh for an example).

Option 3: starting BRAKER after AUGUSTUS training

The trained species parameters for AGUSTUS can be passed with --skipAllTraining and --species $speciesName options. This is illustrated in test*_restart3.sh files. Note that in ETPmode you have to specify the GeneMark files as described in Option 2!

Bug reporting

Before reporting bugs, please check that you are using the most recent versions of GeneMark-ES/ET/EP/ETP, AUGUSTUS and BRAKER. Also, check the list of Common problems, and the Issue list on GitHub before reporting bugs. We do monitor open issues on GitHub. Sometimes, we are unable to help you, immediately, but we try hard to solve your problems.

Reporting bugs on GitHub

If you found a bug, please open an issue at https://github.com/Gaius-Augustus/BRAKER/issues (or contact [email protected] or [email protected]).

Information worth mentioning in your bug report:

Check in braker/yourSpecies/braker.log at which step braker.pl crashed.

There are a number of other files that might be of interest, depending on where in the pipeline the problem occurred. Some of the following files will not be present if they did not contain any errors.

  • braker/yourSpecies/errors/bam2hints.*.stderr - will give details on a bam2hints crash (step for converting bam file to intron gff file)

  • braker/yourSpecies/hintsfile.gff - is this file empty? If yes, something went wrong during hints generation - does this file contain hints from source “b2h” and of type “intron”? If not: GeneMark-ET will not be able to execute properly. Conversely, GeneMark-EP+ will not be able to execute correctly if hints from the source "ProtHint" are missing.

  • braker/yourSpecies/spaln/*err - errors reported by spaln

  • braker/yourSpecies/errors/GeneMark-{ET,EP,ETP}.stderr - errors reported by GeneMark-ET/EP+/ETP

  • braker/yourSpecies/errors/GeneMark-{ET,EP,ETP).stdout - may give clues about the point at which errors in GeneMark-ET/EP+/ETP occured

  • braker/yourSpecies/GeneMark-{ET,EP,ETP}/genemark.gtf - is this file empty? If yes, something went wrong during executing GeneMark-ET/EP+/ETP

  • braker/yourSpecies/GeneMark-{ET,EP}/genemark.f.good.gtf - is this file empty? If yes, something went wrong during filtering GeneMark-ET/EP+ genes for training AUGUSTUS

  • braker/yourSpecies/genbank.good.gb - try a “grep -c LOCUS genbank.good.gb” to determine the number of training genes for training AUGUSTUS, should not be low

  • braker/yourSpecies/errors/firstetraining.stderr - contains errors from first iteration of training AUGUSTUS

  • braker/yourSpecies/errors/secondetraining.stderr - contains errors from second iteration of training AUGUSTUS

  • braker/yourSpecies/errors/optimize_augustus.stderr - contains errors optimize_augustus.pl (additional training set for AUGUSTUS)

  • braker/yourSpecies/errors/augustus*.stderr - contain AUGUSTUS execution errors

  • braker/yourSpecies/startAlign.stderr - if you provided a protein fasta file, something went wrong during protein alignment

  • braker/yourSpecies/startAlign.stdout - may give clues on at which point protein alignment went wrong

Common problems

  • BRAKER complains that the RNA-Seq file does not correspond to the provided genome file, but I am sure the files correspond to each other!

    Please check the headers of the genome FASTA file. If the headers are long and contain whitespaces, some RNA-Seq alignment tools will truncate sequence names in the BAM file. This leads to an error with BRAKER. Solution: shorten/simplify FASTA headers in the genome file before running the RNA-Seq alignment and BRAKER.

  • GeneMark fails!

    (a) GeneMark by default only uses contigs longer than 50k for training. If you have a highly fragmented assembly, this might lead to "no data" for training. You can override the default minimal length by setting the BRAKER argument --min_contig=10000 .

    (b) see "[something] failed to execute" below.

  • [something] failed to execute!

    When providing paths to software to BRAKER, please use absolute, non-abbreviated paths. For example, BRAKER might have problems with --SAMTOOLS_PATH=./samtools/ or --SAMTOOLS_PATH=~/samtools/ . Please use SAMTOOLS_PATH=/full/absolute/path/to/samtools/ , instead. This applies to all path specifications as command line options to braker.pl . Relative paths and absolute paths will not pose problems if you export a bash variable, instead, or if you append the location of tools to your $PATH variable.

  • GeneMark-ETP in BRAKER dies with '/scratch/11232323': No such file or directory.

    This appears to be related to sorting large files, and it's a system configuration depending problem. Solve it with export TMPDIR=/tmp/ before calling BRAKER via Singularity.

  • BRAKER cannot find the Augustus script XYZ...

    Update Augustus from github with git clone https://github.com/Gaius-Augustus/Augustus.git . Do not use Augustus from other sources. BRAKER is highly dependent on an up-to-date Augustus. Augustus releases happen rather rarely, updates to the Augustus scripts folder occur rather frequently.

  • Does BRAKER depend on Python3?

    Это так. The python scripts employed by BRAKER are not compatible with Python2.

  • Why does BRAKER predict more genes than I expected?

    If transposable elements (or similar) have not been masked appropriately, AUGUSTUS tends to predict those elements as protein coding genes. This can lead to a huge number genes. You can check whether this is the case for your project by BLASTing (or DIAMONDing) the predicted protein sequences against themselves (all vs. all) and counting how many of the proteins have a high number of high quality matches. You can use the output of this analysis to divide your gene set into two groups: the protein coding genes that you want to find and the repetitive elements that were additionally predicted.

  • I am running BRAKER in Anaconda and something fails...

    Update AUGUSTUS and BRAKER from github with git clone https://github.com/Gaius-Augustus/Augustus.git and git clone https://github.com/Gaius-Augustus/BRAKER.git . The Anaconda installation is great, but it relies on releases of AUGUSTUS and BRAKER - which are often lagging behind. Please use the current GitHub code, instead.

  • Why and where is the GenomeThreader support gone?

    BRAKER is a joint project between teams from University of Greifswald and Georgia Tech. While the group of Mark Bordovsky from Georgia Tech contributes GeneMark expertise, the group of Mario Stanke from University of Greifswald contributes AUGUSTUS expertise. Using GenomeThreader to build training genes for AUGUSTUS in BRAKER circumvents execution of GeneMark. Thus, the GenomeThreader mode is strictly speaking not part of the BRAKER project. The previous functionality of BRAKER with GenomeThreader has been moved to GALBA at https://github.com/Gaius-Augustus/GALBA. Note that GALBA has also undergone extension for using Miniprot instead of GenomeThreader.

  • My BRAKER gene set has too many BUSCO duplicates!

    AUGUSTUS within BRAKER can predict alternative splicing isoforms. Also the merge of the AUGUSTUS and GeneMark gene set by TSEBRA within BRAKER may result in additional isoforms for a single gene. The BUSCO duplicates usually come from alternative splicing isoforms, ie they are expected.

  • Augustus and/or etraining within BRAKER complain that the file aug_cmdln_parameters.json is missing. Even though I am using the latest Singularity container!

    BRAKER copies the AUGUSTUS_CONFIG_PATH folder to a writable location. In older versions of Augustus, that file was indeed not existing. If the local writable copy of a folder already exists, BRAKER will not re-copy it. Simply delete the old folder. (It is often ~/.augustus , so you can simply do rm -rf ~/.augustus ; the folder might be residing in $PWD if your home directory was not writable).

  • I sit behind a firewall, compleasm cannot download the BUSCO files, what can I do? See Issue #785 (comment)

Citing BRAKER and software called by BRAKER

Since BRAKER is a pipeline that calls several Bioinformatics tools, publication of results obtained by BRAKER requires that not only BRAKER is cited, but also the tools that are called by BRAKER. BRAKER will output a file what-to-cite.txt in the BRAKER working directory, informing you about which exact sources apply to your run.

  • Always cite:

    • Stanke, M., Diekhans, M., Baertsch, R. and Haussler, D. (2008). Using native and syntenically mapped cDNA alignments to improve de novo gene finding. Bioinformatics, doi: 10.1093/bioinformatics/btn013.

    • Stanke. M., Schöffmann, O., Morgenstern, B. and Waack, S. (2006). Gene prediction in eukaryotes with a generalized hidden Markov model that uses hints from external sources. BMC Bioinformatics 7, 62.

  • If you provided any kind of evidence for BRAKER, cite:

    • Gabriel, L., Bruna, T., Hoff, KJ, Borodovsky, M., Stanke, M. (2021) TSEBRA: transcript selector for BRAKER. BMC Bioinformatics 22, 1-12.

  • If you provided both short read RNA-Seq evidence and a large database of proteins, cite:

    • Gabriel, L., Bruna, T., Hoff, KJ, Ebel, M., Lomsadze, A., Borodovsky, M., Stanke, M. (2023). BRAKER3: Fully Automated Genome Annotation Using RNA-Seq and Protein Evidence with GeneMark-ETP, AUGUSTUS and TSEBRA. bioRxiV, doi: 10.1101/2023.06.10.54444910.1101/2023.01.01.474747.

    • Bruna, T., Lomsadze, A., Borodovsky, M. (2023). GeneMark-ETP: Automatic Gene Finding in Eukaryotic Genomes in Consistence with Extrinsic Data. bioRxiv, doi: 10.1101/2023.01.13.524024.

    • Kovaka, S., Zimin, AV, Pertea, GM, Razaghi, R., Salzberg, SL, & Pertea, M. (2019). Transcriptome assembly from long-read RNA-seq alignments with StringTie2. Genome biology, 20(1):1-13.

    • Pertea, G., & Pertea, M. (2020). GFF utilities: GffRead and GffCompare. F1000Research, 9.

    • Quinlan, AR (2014). BEDTools: the Swiss‐army tool for genome feature analysis. Current protocols in bioinformatics, 47(1):11-12.

  • If the only source of evidence for BRAKER was a large database of protein sequences, cite:

    • Bruna, T., Hoff, KJ, Lomsadze, A., Stanke, M., & Borodovsky, M. (2021). BRAKER2: Automatic Eukaryotic Genome Annotation with GeneMark-EP+ and AUGUSTUS Supported by a Protein Database. NAR Genomics and Bioinformatics 3(1):lqaa108, doi: 10.1093/nargab/lqaa108.

  • If the only source of evidence for BRAKER was RNA-Seq data, cite:

    • Hoff, KJ, Lange, S., Lomsadze, A., Borodovsky, M. and Stanke, M. (2016). BRAKER1: unsupervised RNA-Seq-based genome annotation with GeneMark-ET and AUGUSTUS. Bioinformatics, 32(5):767-769.

    • Lomsadze, A., Paul DB, and Mark B. (2014) Integration of Mapped Rna-Seq Reads into Automatic Training of Eukaryotic Gene Finding Algorithm. Nucleic Acids Research 42(15): e119--e119

  • If you called BRAKER3 with an IsoSeq BAM file, or if you envoked the --busco_lineage option, cite:

    • Bruna, T., Gabriel, L., Hoff, KJ (2024). Navigating Eukaryotic Genome Annotation Pipelines: A Route Map to BRAKER, Galba, and TSEBRA. arXiv, doi: 10.48550/arXiv.2403.19416 .

  • If you called BRAKER with the --busco_lineage option, in addition, cite:

    • Simão, FA, Waterhouse, RM, Ioannidis, P., Kriventseva, EV, & Zdobnov, EM (2015). BUSCO: assessing genome assembly and annotation completeness with single-copy orthologs. Bioinformatics, 31(19), 3210-3212.

    • Li, H. (2023). Protein-to-genome alignment with miniprot. Bioinformatics, 39(1), btad014.

    • Huang, N., & Li, H. (2023). compleasm: a faster and more accurate reimplementation of BUSCO. Bioinformatics, 39(10), btad595.

  • If any kind of AUGUSTUS training was performed by BRAKER, check carefully whether you configured BRAKER to use NCBI BLAST or DIAMOND. One of them was used to filter out redundant training gene structures.

    • If you used NCBI BLAST, please cite:

      • Altschul, AF, Gish, W., Miller, W., Myers, EW and Lipman, DJ (1990). A basic local alignment search tool. J Mol Biol 215:403--410.

      • Camacho, C., Coulouris, G., Avagyan, V., Ma, N., Papadopoulos, J., Bealer, K., and Madden, TL (2009). Blast+: architecture and applications. BMC bioinformatics, 10(1):421.

    • If you used DIAMOND, please cite:

      • Buchfink, B., Xie, C., Huson, DH (2015). Fast and sensitive protein alignment using DIAMOND. Nature Methods 12:59-60.

  • If BRAKER was executed with a genome file and no extrinsic evidence, cite, then GeneMark-ES was used, cite:

    • Lomsadze, A., Ter-Hovhannisyan, V., Chernoff, YO and Borodovsky, M. (2005). Gene identification in novel eukaryotic genomes by self-training algorithm. Nucleic Acids Research, 33(20):6494--6506.

    • Ter-Hovhannisyan, V., Lomsadze, A., Chernoff, YO and Borodovsky, M. (2008). Gene prediction in novel fungal genomes using an ab initio algorithm with unsupervised training. Genome research, pages gr--081612, 2008.

    • Hoff, KJ, Lomsadze, A., Borodovsky, M. and Stanke, M. (2019). Whole-Genome Annotation with BRAKER. Methods Mol Biol. 1962:65-95, doi: 10.1007/978-1-4939-9173-0_5.

  • If BRAKER was run with proteins as source of evidence, please cite all tools that are used by the ProtHint pipeline to generate hints:

    • Bruna, T., Lomsadze, A., & Borodovsky, M. (2020). GeneMark-EP+: eukaryotic gene prediction with self-training in the space of genes and proteins. NAR Genomics and Bioinformatics, 2(2), lqaa026.

    • Buchfink, B., Xie, C., Huson, DH (2015). Fast and sensitive protein alignment using DIAMOND. Nature Methods 12:59-60.

    • Lomsadze, A., Ter-Hovhannisyan, V., Chernoff, YO and Borodovsky, M. (2005). Gene identification in novel eukaryotic genomes by self-training algorithm. Nucleic Acids Research, 33(20):6494--6506.

    • Iwata, H., and Gotoh, O. (2012). Benchmarking spliced alignment programs including Spaln2, an extended version of Spaln that incorporates additional species-specific features. Nucleic acids research, 40(20), e161-e161.

    • Gotoh, O., Morita, M., Nelson, DR (2014). Assessment and refinement of eukaryotic gene structure prediction with gene-structure-aware multiple protein sequence alignment. BMC bioinformatics, 15(1), 189.

  • If BRAKER was executed with RNA-Seq alignments in bam-format, then SAMtools was used, cite:

    • Li, H., Handsaker, B., Wysoker, A., Fennell, T., Ruan, J., Homer, N., Marth, G., Abecasis, G., Durbin, R.; 1000 Genome Project Data Processing Subgroup (2009). The Sequence Alignment/Map format and SAMtools. Bioinformatics, 25(16):2078-9.

    • Barnett, DW, Garrison, EK, Quinlan, AR, Strömberg, MP and Marth GT (2011). BamTools: a C++ API and toolkit for analyzing and managing BAM files. Bioinformatics, 27(12):1691-2

  • If BRAKER downloaded RNA-Seq libraries from SRA using their IDs, cite SRA, SRA toolkit, and HISAT2:

    • Leinonen, R., Sugawara, H., Shumway, M., & International Nucleotide Sequence Database Collaboration. (2010). The sequence read archive. Nucleic acids research, 39(suppl_1), D19-D21.

    • SRA Toolkit Development Team (2020). SRA Toolkit. https://trace.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.

    • Kim, D., Paggi, JM, Park, C., Bennett, C., & Salzberg, SL (2019). Graph-based genome alignment and genotyping with HISAT2 and HISAT-genotype. Nature biotechnology, 37(8):907-915.

  • If BRAKER was executed using RNA-Seq data in FASTQ format, cite HISAT2:

    • Kim, D., Paggi, JM, Park, C., Bennett, C., & Salzberg, SL (2019). Graph-based genome alignment and genotyping with HISAT2 and HISAT-genotype. Nature biotechnology, 37(8):907-915.

  • If BRAKER called MakeHub for creating a track data hub for visualization of BRAKER results with the UCSC Genome Browser, cite:

    • Hoff, KJ (2019). MakeHub: fully automated generation of UCSC genome browser assembly hubs. Genomics, Proteomics and Bioinformatics, 17(5), 546-549.

  • If BRAKER called GUSHR for generating UTRs, cite:

    • Keilwagen, J., Hartung, F., Grau, J. (2019) GeMoMa: Homology-based gene prediction utilizing intron position conservation and RNA-seq data. Methods Mol Biol. 1962:161-177, doi: 10.1007/978-1-4939-9173-0_9.

    • Keilwagen, J., Wenk, M., Erickson, JL, Schattat, MH, Grau, J., Hartung F. (2016) Using intron position conservation for homology-based gene prediction. Nucleic Acids Research, 44(9):e89.

    • Keilwagen, J., Hartung, F., Paulini, M., Twardziok, SO, Grau, J. (2018) Combining RNA-seq data and homology-based gene prediction for plants, animals and fungi. BMC Bioinformatics, 19(1):189.

Лицензия

All source code, ie scripts/*.pl or scripts/*.py are under the Artistic License (see http://www.opensource.org/licenses/artistic-license.php).

Сноски

[F1] EX = ES/ET/EP/ETP, all available for download under the name GeneMark-ES/ET/EP ↩

[F2] Please use the latest version from the master branch of AUGUSTUS distributed by the original developers, it is available from github at https://github.com/Gaius-Augustus/Augustus. Problems have been reported from users that tried to run BRAKER with AUGUSTUS releases maintained by third parties, ie Bioconda. ↩

[F4] install with sudo apt-get install cpanminus ↩

[F6] The binary may eg reside in bamtools/build/src/toolkit ↩

Ссылки

[R0] Bruna, Tomas, Hoff, Katharina J., Lomsadze, Alexandre, Stanke, Mario, and Borodovsky, Mark. 2021. “BRAKER2: automatic eukaryotic genome annotation with GeneMark-EP+ and AUGUSTUS supported by a protein database." NAR Genomics and Bioinformatics 3(1):lqaa108.↩

[R1] Hoff, Katharina J, Simone Lange, Alexandre Lomsadze, Mark Borodovsky, and Mario Stanke. 2015. “BRAKER1: Unsupervised Rna-Seq-Based Genome Annotation with Genemark-et and Augustus.” Bioinformatics 32 (5). Oxford University Press: 767--69.↩

[R2] Lomsadze, Alexandre, Paul D Burns, and Mark Borodovsky. 2014. “Integration of Mapped Rna-Seq Reads into Automatic Training of Eukaryotic Gene Finding Algorithm.” Nucleic Acids Research 42 (15). Oxford University Press: e119--e119.↩

[R3] Stanke, Mario, Mark Diekhans, Robert Baertsch, and David Haussler. 2008. “Using Native and Syntenically Mapped cDNA Alignments to Improve de Novo Gene Finding.” Bioinformatics 24 (5). Oxford University Press: 637--44.↩

[R4] Stanke, Mario, Oliver Schöffmann, Burkhard Morgenstern, and Stephan Waack. 2006. “Gene Prediction in Eukaryotes with a Generalized Hidden Markov Model That Uses Hints from External Sources.” BMC Bioinformatics 7 (1). BioMed Central: 62.↩

[R5] Barnett, Derek W, Erik K Garrison, Aaron R Quinlan, Michael P Strömberg, and Gabor T Marth. 2011. “BamTools: A C++ Api and Toolkit for Analyzing and Managing Bam Files.” Bioinformatics 27 (12). Oxford University Press: 1691--2.↩

[R6] Li, Heng, Handsaker, Bob, Alec Wysoker, Tim Fennell, Jue Ruan, Nils Homer, Gabor Marth, Goncalo Abecasis, and Richard Durbin. 2009. “The Sequence Alignment/Map Format and Samtools.” Bioinformatics 25 (16). Oxford University Press: 2078--9.↩

[R7] Gremme, G. 2013. “Computational Gene Structure Prediction.” PhD thesis, Universität Hamburg.↩

[R8] Gotoh, Osamu. 2008a. “A Space-Efficient and Accurate Method for Mapping and Aligning cDNA Sequences onto Genomic Sequence.” Nucleic Acids Research 36 (8). Oxford University Press: 2630--8.↩

[R9] Iwata, Hiroaki, and Osamu Gotoh. 2012. “Benchmarking Spliced Alignment Programs Including Spaln2, an Extended Version of Spaln That Incorporates Additional Species-Specific Features.” Nucleic Acids Research 40 (20). Oxford University Press: e161--e161.↩

[R10] Osamu Gotoh. 2008b. “Direct Mapping and Alignment of Protein Sequences onto Genomic Sequence.” Bioinformatics 24 (21). Oxford University Press: 2438--44.↩

[R11] Slater, Guy St C, and Ewan Birney. 2005. “Automated Generation of Heuristics for Biological Sequence Comparison.” BMC Bioinformatics 6(1). BioMed Central: 31.↩

[R12] Altschul, SF, W. Gish, W. Miller, EW Myers, and DJ Lipman. 1990. “Basic Local Alignment Search Tool.” Journal of Molecular Biology 215:403--10.↩

[R13] Camacho, Christiam, et al. 2009. “BLAST+: architecture and applications.“ BMC Bioinformatics 1(1): 421.↩

[R14] Lomsadze, A., V. Ter-Hovhannisyan, YO Chernoff, and M. Borodovsky. 2005. “Gene identification in novel eukaryotic genomes by self-training algorithm.” Nucleic Acids Research 33 (20): 6494--6506. doi:10.1093/nar/gki937.↩

[R15] Ter-Hovhannisyan, Vardges, Alexandre Lomsadze, Yury O Chernoff, and Mark Borodovsky. 2008. “Gene Prediction in Novel Fungal Genomes Using an Ab Initio Algorithm with Unsupervised Training.” Genome Research . Cold Spring Harbor Lab, gr--081612.↩

[R16] Hoff, KJ 2019. MakeHub: Fully automated generation of UCSC Genome Browser Assembly Hubs. Genomics, Proteomics and Bioinformatics , in press, preprint on bioarXive, doi: https://doi.org/10.1101/550145.↩

[R17] Bruna, T., Lomsadze, A., & Borodovsky, M. 2020. GeneMark-EP+: eukaryotic gene prediction with self-training in the space of genes and proteins. NAR Genomics and Bioinformatics, 2(2), lqaa026. doi: https://doi.org/10.1093/nargab/lqaa026.↩

[R18] Kriventseva, EV, Kuznetsov, D., Tegenfeldt, F., Manni, M., Dias, R., Simão, FA, and Zdobnov, EM 2019. OrthoDB v10: sampling the diversity of animal, plant, fungal, protist, bacterial and viral genomes for evolutionary and functional annotations of orthologs. Nucleic Acids Research, 47(D1), D807-D811.↩

[R19] Keilwagen, J., Hartung, F., Grau, J. (2019) GeMoMa: Homology-based gene prediction utilizing intron position conservation and RNA-seq data. Methods Mol Biol. 1962:161-177, doi: 10.1007/978-1-4939-9173-0_9.↩

[R20] Keilwagen, J., Wenk, M., Erickson, JL, Schattat, MH, Grau, J., Hartung F. (2016) Using intron position conservation for homology-based gene prediction. Nucleic Acids Research, 44(9):e89.↩

[R21] Keilwagen, J., Hartung, F., Paulini, M., Twardziok, SO, Grau, J. (2018) Combining RNA-seq data and homology-based gene prediction for plants, animals and fungi. BMC Bioinformatics, 19(1):189.↩

[R22] SRA Toolkit Development Team (2020). SRA Toolkit. https://trace.ncbi.nlm.nih.gov/Traces/sra/sra.cgi?view=software.[↩](#a22)

[R23] Kim, D., Paggi, JM, Park, C., Bennett, C., & Salzberg, SL (2019). Graph-based genome alignment and genotyping with HISAT2 and HISAT-genotype. Nature biotechnology, 37(8):907-915.↩

[R24] Quinlan, AR (2014). BEDTools: the Swiss‐army tool for genome feature analysis. Current protocols in bioinformatics, 47(1):11-12.↩

[R25] Kovaka, S., Zimin, AV, Pertea, GM, Razaghi, R., Salzberg, SL, & Pertea, M. (2019). Transcriptome assembly from long-read RNA-seq alignments with StringTie2. Genome biology, 20(1):1-13.↩

[R26] Pertea, G., & Pertea, M. (2020). GFF utilities: GffRead and GffCompare. F1000Research, 9.↩

[R27] Huang, N., & Li, H. (2023). compleasm: a faster and more accurate reimplementation of BUSCO. Bioinformatics, 39(10), btad595.↩

[R28] Bruna, T., Gabriel, L. & Hoff, KJ (2024). Navigating Eukaryotic Genome Annotation Pipelines: A Route Map to BRAKER, Galba, and TSEBRA. arXiv, https://doi.org/10.48550/arXiv.2403.19416 .↩

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все