picard

Поддержка пользователей:

На вопросы пользователей ищите ответы и задавайте их сначала на форуме GATK.

---

Набор инструментов командной строки Java для управления данными и форматами высокопроизводительного секвенирования (HTS).

Picard реализован с использованием библиотеки Java HTSJDK HTSJDK для поддержки доступа к форматам файлов, которые обычно используются для данных высокопроизводительного секвенирования, таких как SAM и VCF.

Начиная с версии 3.0, Picard требует Java 1.17.

Здание Пикарда

• Сначала клонируйте репо:

    git clone https://github.com/broadinstitute/picard.git
    cd picard/

• Picard теперь собирается с использованием gradle. Включен скрипт-оболочка ( gradlew ), который загрузит соответствующую версию gradle при первом вызове.

• Чтобы создать полностью упакованный работоспособный jar-файл Picard со всеми включенными зависимостями, запустите:

    ./gradlew shadowJar

• Полученный jar-файл будет находиться в build/libs . Чтобы запустить его, команда:

    java -jar build/libs/picard.jar
    
    or
    
    java -jar build/libs/picard-<VERSION>-all.jar 

• Чтобы создать банку, содержащую только классы Пикарда (без его зависимостей), запустите:

    ./gradlew jar

• Чтобы очистить каталог сборки, запустите:

    ./gradlew clean

Запуск тестов

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

    ./gradlew test

• Чтобы запустить конкретный тест, используйте команду:

    ./gradlew legacyTest --tests "*TestClassName*"
    
    or
    
    ./gradlew barclayTest --tests "*TestClassName*"

При запуске legacyTest используется устаревший анализатор командной строки, а при запуске barclayTest — новый синтаксический анализатор.

Изменение выпущенной версии HTSJDK, от которой зависит Пикард

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

• Открыть build.gradle
• Отредактируйте VERSION в следующей строке, чтобы указать другую выпущенную версию HTSJDK. Релизы HTSJDK перечислены здесь.

    final htsjdkVersion = System.getProperty('htsjdk.version', 'VERSION')`

• Откройте запрос на включение с этим изменением

Сборка Picard с помощью специальной версии HTSJDK

Во время разработки в Picard иногда необходимо выполнить локальную сборку с использованием невыпущенной версии или ветки HTSJDK.

• Чтобы выполнить сборку на основе невыпущенной версии главной ветки HTSJDK:

  • Перейдите в артефакт Broad, где публикуются непрерывные снимки главной ветки HTSJDK, и выберите версию, которую вы хотите использовать. Например, 2.5.1-9-g5740ca1-SNAPSHOT . Вы можете искать по тегу или короткому хешу коммита git.
  • В своем клоне Picard запустите ./gradlew shadowJar -Dhtsjdk.version=VERSION , где VERSION — это версия снимка главной ветки HTSJDK, которую вы хотите использовать.

• Чтобы построить версию HTSJDK, которая еще не была объединена с основной веткой HTSJDK:

  • Клонируйте HTSJDK и в своем клоне проверьте тег или ветку, с которой вы хотите собрать Picard.
  • Запустите ./gradlew install printVersion в своем клоне htsjdk, чтобы установить эту версию в локальный репозиторий maven. Обратите внимание на номер версии, который напечатан в конце.
  • Вернитесь к своему клону Пикарда и запустите ./gradlew shadowJar -Dhtsjdk.version=VERSION , где VERSION — это версия HTSJDK, которую вы установили в локальный репозиторий maven.

Освобождение Пикарда

Полные инструкции по созданию новой версии Picard находятся здесь.

Поставщики путей

Picard имеет ограниченную поддержку чтения от поставщиков Path. В настоящее время поддерживается только API Google, и лишь несколько инструментов поддерживают это. Чтобы использовать эту поддержку, вам необходимо скомпилировать цель CloudJar с помощью gradle:

./gradlew cloudJar

затем запустите picard следующим образом:

java -jar build/lib/picardcloud.jar < Picard arguments starting from program >

Например:

java -jar build/lib/picardcloud.jar CrosscheckFingerprints 
   I=gs://sample1.vcf 
   I=gs://sample2.vcf 
   CROSSCHECK_BY=FILE 
   H=Haplotype_db.txt 
   O=crosscheck.out

Альтернативно вы можете запустить инструмент через GATK, который включает в себя jar Google-Cloud и, таким образом, должен «просто работать».

---

Цитирование

Пожалуйста, ссылайтесь на этот репозиторий при использовании инструментов Picard для своих публикаций.

«Набор инструментов Пикарда». 2019. Институт Броуда, репозиторий GitHub. https://broadinstitute.github.io/picard/; Броуд Институт

 @misc{Picard2019toolkit,
  title = {Picard toolkit},
  year = {2019},
  publisher = {Broad Institute},
  journal = {Broad Institute, GitHub repository},
  howpublished = {url{https://broadinstitute.github.io/picard/}}
}

Идентификаторы из реестров программного обеспечения все чаще принимаются журналами, например (biotools:picard_tools) или (RRID:SCR_006525).

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

Дополнительную информацию см. в документации Picard.