picard

Benutzerunterstützung:

Bei Benutzerfragen suchen Sie bitte nach Antworten und stellen Sie diese zunächst im GATK-Forum.

---

Eine Reihe von Java-Befehlszeilentools zum Bearbeiten von HTS-Daten und -Formaten (High Throughput Sequencing).

Picard wird mithilfe der HTSJDK-Java-Bibliothek HTSJDK implementiert, um den Zugriff auf Dateiformate zu unterstützen, die häufig für Sequenzierungsdaten mit hohem Durchsatz verwendet werden, wie z. B. SAM und VCF.

Ab Version 3.0 benötigt Picard Java 1.17.

Picard bauen

• Klonen Sie zunächst das Repo:

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

• Picard wird jetzt mit Gradle erstellt. Ein Wrapper-Skript ( gradlew ) ist enthalten, das beim ersten Aufruf die entsprechende Version von gradle herunterlädt.

• Führen Sie Folgendes aus, um ein vollständig gepacktes, ausführbares Picard-JAR mit allen Abhängigkeiten zu erstellen:

    ./gradlew shadowJar

• Das resultierende JAR befindet sich in build/libs . Um es auszuführen, lautet der Befehl:

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

• Um ein JAR zu erstellen, das nur Picard-Klassen (ohne seine Abhängigkeiten) enthält, führen Sie Folgendes aus:

    ./gradlew jar

• Um das Build-Verzeichnis zu bereinigen, führen Sie Folgendes aus:

    ./gradlew clean

Ausführen von Tests

• Um alle Tests auszuführen, lautet der Befehl:

    ./gradlew test

• Um einen bestimmten Test auszuführen, lautet der Befehl:

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

Beim Ausführen von legacyTest wird der Legacy-Befehlszeilenparser verwendet, während barclayTest den neuen Parser verwendet.

Ändern der veröffentlichten Version von HTSJDK, von der Picard abhängig ist

Um die HTSJDK-Abhängigkeit von Picard auf eine andere veröffentlichte Version umzustellen:

• Öffnen Sie build.gradle
• Bearbeiten Sie VERSION in der folgenden Zeile, um eine andere veröffentlichte Version von HTSJDK zu verwenden. HTSJDK-Releases sind hier aufgelistet

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

• Öffnen Sie eine Pull-Anfrage mit dieser Änderung

Picard mit einer benutzerdefinierten Version von HTSJDK erstellen

Während der Entwicklung in Picard ist es manchmal notwendig, lokal mit einer unveröffentlichten Version oder einem unveröffentlichten Zweig von HTSJDK zu bauen.

• So bauen Sie mit einer unveröffentlichten Version des Master-Zweigs von HTSJDK:

  • Gehen Sie zum Broad-Artefakt, wo kontinuierliche Snapshots des Hauptzweigs von HTSJDK veröffentlicht werden, und wählen Sie die Version aus, die Sie verwenden möchten. Beispiel: 2.5.1-9-g5740ca1-SNAPSHOT . Sie können nach Tag oder kurzem Git-Commit-Hash suchen.
  • Führen Sie in Ihrem Picard-Klon ./gradlew shadowJar -Dhtsjdk.version=VERSION aus, wobei VERSION die Version des HTSJDK-Master-Branch-Snapshots ist, den Sie verwenden möchten.

• So erstellen Sie eine Version von HTSJDK, die noch nicht in den Hauptzweig von HTSJDK eingebunden wurde:

  • Klonen Sie HTSJDK und überprüfen Sie in Ihrem Klon das Tag oder den Zweig, mit dem Sie Picard erstellen möchten.
  • Führen Sie ./gradlew install printVersion in Ihrem htsjdk-Klon aus, um diese Version in Ihrem lokalen Maven-Repository zu installieren. Beachten Sie die Versionsnummer, die am Ende gedruckt wird.
  • Wechseln Sie zurück zu Ihrem Picard-Klon und führen Sie ./gradlew shadowJar -Dhtsjdk.version=VERSION aus, wobei VERSION die Version von HTSJDK ist, die Sie in Ihrem lokalen Maven-Repository installiert haben.

Picard freilassen

Vollständige Anweisungen zum Erstellen einer neuen Version von Picard finden Sie hier

Pfadanbieter

Picard bietet nur begrenzte Unterstützung für das Lesen von Pfadanbietern. Derzeit wird nur die API von Google unterstützt, und nur wenige Tools unterstützen dies. Um diese Unterstützung nutzen zu können, müssen Sie das cloudJar-Ziel mit Gradle kompilieren:

./gradlew cloudJar

Führen Sie dann Picard wie folgt aus:

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

Zum Beispiel:

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

Alternativ können Sie das Tool über das GATK ausführen, das das Google-Cloud-JAR bündelt und somit „einfach funktionieren“ sollte.

---

Zitieren

Bitte zitieren Sie dieses Repository, wenn Sie Picard-Tools für Ihre Veröffentlichungen verwenden.

„Picard-Toolkit.“ 2019. Broad Institute, GitHub Repository. https://broadinstitute.github.io/picard/; Breites Institut

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

Identifikatoren aus Software-Registern werden zunehmend von Zeitschriften akzeptiert, wie in (biotools:picard_tools) oder (RRID:SCR_006525).

Picard migriert zur semantischen Versionierung. Wir werden uns letztendlich strikt daran halten und unsere Hauptversion aktualisieren, wenn es bahnbrechende Änderungen an unserer API gibt. Bis wir jedoch klarer definieren, was unsere offizielle API ausmacht, sollten Kunden davon ausgehen, dass jede Version möglicherweise zumindest geringfügige Änderungen an öffentlichen Methoden enthält.

Weitere Informationen finden Sie in der Picard-Dokumentation.