picard

Assistance utilisateur :

Pour les questions des utilisateurs, veuillez rechercher des réponses et les poser d'abord sur le forum GATK.

---

Un ensemble d'outils de ligne de commande Java pour manipuler les données et les formats de séquençage à haut débit (HTS).

Picard est implémenté à l'aide de la bibliothèque Java HTSJDK HTSJDK pour prendre en charge l'accès aux formats de fichiers couramment utilisés pour les données de séquençage à haut débit telles que SAM et VCF.

Depuis la version 3.0, Picard nécessite Java 1.17.

Bâtiment Picard

• Tout d’abord, clonez le dépôt :

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

• Picard est maintenant construit en utilisant Gradle. Un script wrapper ( gradlew ) est inclus qui téléchargera la version appropriée de gradle lors du premier appel.

• Pour créer un pot Picard entièrement packagé et exécutable avec toutes les dépendances incluses, exécutez :

    ./gradlew shadowJar

• Le pot résultant sera dans build/libs . Pour l'exécuter, la commande est :

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

• Pour construire un jar contenant uniquement des classes Picard (sans ses dépendances), exécutez :

    ./gradlew jar

• Pour nettoyer le répertoire de build, exécutez :

    ./gradlew clean

Exécution de tests

• Pour exécuter tous les tests, la commande est :

    ./gradlew test

• Pour exécuter un test spécifique, la commande est :

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

L'exécution legacyTest utilise l'ancien analyseur de ligne de commande tandis que barclayTest utilise le nouvel analyseur.

Modification de la version publiée de HTSJDK dont dépend Picard

Pour basculer la dépendance HTSJDK de Picard vers une autre version publiée :

• Ouvrez build.gradle
• Modifiez VERSION dans la ligne suivante pour qu'il s'agisse d'une version différente de HTSJDK. Les versions HTSJDK sont répertoriées ici

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

• Ouvrir une pull request avec ce changement

Construire Picard avec une version personnalisée de HTSJDK

Lors du développement dans Picard, il est parfois nécessaire de construire localement sur une version ou une branche inédite de HTSJDK.

• Pour construire avec une version inédite de la branche principale de HTSJDK :

  • Accédez à l'artefact Broad, où sont publiés des instantanés continus de la branche principale de HTSJDK, et sélectionnez la version que vous souhaitez utiliser. Par exemple, 2.5.1-9-g5740ca1-SNAPSHOT . Vous pouvez effectuer une recherche par balise ou par hachage git commit court.
  • Dans votre clone Picard, exécutez ./gradlew shadowJar -Dhtsjdk.version=VERSION , où VERSION est la version de l'instantané de branche principale HTSJDK que vous souhaitez utiliser.

• Pour construire avec une version de HTSJDK qui n'a pas encore été fusionnée dans la branche principale de HTSJDK :

  • Clonez HTSJDK et, dans votre clone, vérifiez la balise ou la branche avec laquelle vous souhaitez créer Picard.
  • Exécutez ./gradlew install printVersion dans votre clone htsjdk pour installer cette version dans votre référentiel maven local. Notez le numéro de version imprimé à la fin.
  • Revenez à votre clone Picard et exécutez ./gradlew shadowJar -Dhtsjdk.version=VERSION , où VERSION est la version de HTSJDK que vous avez installée sur votre référentiel maven local.

Libérer Picard

Les instructions complètes sur la façon de créer une nouvelle version de Picard sont ici

Fournisseurs de chemins

Picard offre une prise en charge limitée pour la lecture auprès des fournisseurs Path. Actuellement, seule l'API de Google est prise en charge, et seuls quelques outils le prennent en charge. Pour exécuter avec ce support, vous devez compiler la cible cloudJar avec gradle :

./gradlew cloudJar

puis exécutez Picard comme suit :

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

Par exemple:

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

Alternativement, vous pouvez exécuter l'outil via le GATK qui regroupe le fichier jar Google-Cloud et devrait donc « juste fonctionner ».

---

Citer

Veuillez citer ce référentiel lorsque vous utilisez les outils Picard pour vos publications.

«Boîte à outils Picard». 2019. Broad Institute, référentiel GitHub. https://broadinstitute.github.io/picard/ ; Institut élargi

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

Les identifiants des registres de logiciels sont de plus en plus acceptés par les revues, comme dans (biotools:picard_tools) ou (RRID:SCR_006525).

Picard migre vers le versioning sémantique. Nous finirons par y adhérer strictement et augmenterons notre version majeure chaque fois que des modifications majeures seront apportées à notre API, mais jusqu'à ce que nous définissions plus clairement ce qui constitue notre API officielle, les clients doivent supposer que chaque version contient potentiellement au moins des modifications mineures des méthodes publiques.

Veuillez consulter la documentation Picard pour plus d'informations.