picard

Soporte al usuario:

Para preguntas de los usuarios, busque respuestas y pregunte primero en el foro GATK.

---

Un conjunto de herramientas de línea de comandos de Java para manipular datos y formatos de secuenciación de alto rendimiento (HTS).

Picard se implementa utilizando la biblioteca HTSJDK Java HTSJDK para admitir el acceso a formatos de archivo que se usan comúnmente para datos de secuenciación de alto rendimiento, como SAM y VCF.

A partir de la versión 3.0, Picard requiere Java 1.17.

Edificio Picard

• Primero, clona el repositorio:

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

• Picard ahora se construye usando gradle. Se incluye un script contenedor ( gradlew ) que descargará la versión apropiada de gradle en la primera invocación.

• Para crear un jar Picard ejecutable y completamente empaquetado con todas las dependencias incluidas, ejecute:

    ./gradlew shadowJar

• El archivo jar resultante estará en build/libs . Para ejecutarlo, el comando es:

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

• Para construir un jar que contenga solo clases Picard (sin sus dependencias), ejecute:

    ./gradlew jar

• Para limpiar el directorio de compilación, ejecute:

    ./gradlew clean

Ejecución de pruebas

• Para ejecutar todas las pruebas, el comando es:

    ./gradlew test

• Para ejecutar una prueba específica, el comando es:

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

La ejecución legacyTest utiliza el analizador de línea de comandos heredado, mientras que barclayTest utiliza el nuevo analizador.

Cambiar la versión publicada de HTSJDK de la que depende Picard

Para cambiar la dependencia HTSJDK de Picard a una versión publicada diferente:

• Abrir build.gradle
• Edite VERSIÓN en la siguiente línea para que sea una versión publicada diferente de HTSJDK. Las versiones de HTSJDK se enumeran aquí

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

• Abra una solicitud de extracción con este cambio

Construyendo Picard con una versión personalizada de HTSJDK

Durante el desarrollo en Picard, a veces es necesario compilar localmente con una versión o rama inédita de HTSJDK.

• Para compilar con una versión inédita de la rama maestra de HTSJDK:

  • Vaya al artefacto amplio, donde se publican instantáneas continuas de la rama maestra de HTSJDK, y seleccione la versión que desea usar. Por ejemplo, 2.5.1-9-g5740ca1-SNAPSHOT . Puede buscar por etiqueta o hash corto de confirmación de git.
  • En su clon de Picard, ejecute ./gradlew shadowJar -Dhtsjdk.version=VERSION , donde VERSIÓN es la versión de la instantánea de la rama maestra HTSJDK que desea usar.

• Para compilar con una versión de HTSJDK que aún no se ha fusionado en la rama maestra de HTSJDK:

  • Clona HTSJDK y, en tu clon, verifica la etiqueta o rama con la que deseas construir Picard.
  • Ejecute ./gradlew install printVersion en su clon de htsjdk para instalar esa versión en su repositorio maven local. Tome nota del número de versión que aparece impreso al final.
  • Vuelva a su clon de Picard y ejecute ./gradlew shadowJar -Dhtsjdk.version=VERSION , donde VERSIÓN es la versión de HTSJDK que instaló en su repositorio maven local.

Liberando a Picard

Las instrucciones completas sobre cómo crear una nueva versión de Picard están aquí

Proveedores de rutas

Picard tiene soporte limitado para la lectura de proveedores de Path. Actualmente, solo se admite la API de Google y solo unas pocas herramientas lo admiten. Para ejecutar con este soporte, necesita compilar el destino cloudJar con gradle:

./gradlew cloudJar

luego ejecute picard de la siguiente manera:

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

Por ejemplo:

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

Alternativamente, puede ejecutar la herramienta a través de GATK que incluye el jar de Google-Cloud y, por lo tanto, debería "simplemente funcionar".

---

Citando

Cite este repositorio cuando utilice las herramientas de Picard para sus publicaciones.

"Kit de herramientas de Picard". 2019. Broad Institute, Repositorio GitHub. https://broadinstitute.github.io/picard/; Instituto amplio

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

Las revistas aceptan cada vez más los identificadores de registros de software, como en (biotools:picard_tools) o (RRID:SCR_006525).

Picard está migrando al control de versiones semántico. Eventualmente lo cumpliremos estrictamente y eliminaremos nuestra versión principal cada vez que haya cambios importantes en nuestra API, pero hasta que definamos más claramente qué constituye nuestra API oficial, los clientes deben asumir que cada versión contiene potencialmente al menos cambios menores en los métodos públicos.

Consulte la documentación de Picard para obtener más información.