picard

Dukungan Pengguna:

Untuk pertanyaan pengguna silahkan mencari jawaban dan bertanya terlebih dahulu di forum GATK.

---

Seperangkat alat baris perintah Java untuk memanipulasi data dan format pengurutan throughput tinggi (HTS).

Picard diimplementasikan menggunakan perpustakaan HTSJDK Java HTSJDK untuk mendukung pengaksesan format file yang biasa digunakan untuk data pengurutan throughput tinggi seperti SAM dan VCF.

Pada versi 3.0, Picard memerlukan Java 1.17.

Membangun Picard

• Pertama, kloning repo:

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

• Picard sekarang dibuat menggunakan gradle. Skrip pembungkus ( gradlew ) disertakan yang akan mengunduh versi gradle yang sesuai pada pemanggilan pertama.

• Untuk membuat toples Picard yang dikemas lengkap dan dapat dijalankan dengan semua dependensi disertakan, jalankan:

    ./gradlew shadowJar

• Stoples yang dihasilkan akan berada di build/libs . Untuk menjalankannya, perintahnya adalah:

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

• Untuk membuat toples yang hanya berisi kelas Picard (tanpa ketergantungannya), jalankan:

    ./gradlew jar

• Untuk membersihkan direktori build, jalankan:

    ./gradlew clean

Tes Berjalan

• Untuk menjalankan semua tes, perintahnya adalah:

    ./gradlew test

• Untuk menjalankan tes tertentu, perintahnya adalah:

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

Menjalankan legacyTest menggunakan parser baris perintah lama sementara barclayTest menggunakan parser baru.

Mengubah versi rilis HTSJDK yang diandalkan Picard

Untuk mengalihkan ketergantungan HTSJDK Picard ke versi rilis lain:

• Buka build.gradle
• Edit VERSION pada baris berikut untuk menjadi versi rilis HTSJDK yang berbeda. Rilis HTSJDK tercantum di sini

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

• Buka permintaan tarik dengan perubahan ini

Membangun Picard dengan Versi Kustom HTSJDK

Selama pengembangan di Picard, terkadang perlu untuk membangun secara lokal terhadap versi atau cabang HTSJDK yang belum dirilis.

• Untuk membangun versi cabang master HTSJDK yang belum pernah dirilis:

  • Buka artefak Broad, tempat snapshot berkelanjutan dari cabang master HTSJDK diterbitkan, dan pilih versi yang ingin Anda gunakan. Misalnya, 2.5.1-9-g5740ca1-SNAPSHOT . Anda dapat mencari berdasarkan tag atau hash git commit pendek.
  • Di klon Picard Anda, jalankan ./gradlew shadowJar -Dhtsjdk.version=VERSION , dengan VERSION adalah versi snapshot cabang master HTSJDK yang ingin Anda gunakan.

• Untuk membangun versi HTSJDK yang belum digabungkan ke dalam cabang master HTSJDK:

  • Kloning HTSJDK, dan di klon Anda, periksa tag atau cabang tempat Anda ingin membuat Picard.
  • Jalankan ./gradlew install printVersion di klon htsjdk Anda untuk menginstal versi tersebut ke repositori pakar lokal Anda. Catat nomor versi yang dicetak di bagian akhir.
  • Beralih kembali ke klon Picard Anda, dan jalankan ./gradlew shadowJar -Dhtsjdk.version=VERSION , dengan VERSION adalah versi HTSJDK yang Anda instal ke repositori maven lokal Anda.

Melepaskan Picard

Petunjuk lengkap tentang cara membuat rilis baru Picard ada di sini

Penyedia jalur

Picard memiliki dukungan terbatas untuk membaca dari penyedia Path. Saat ini hanya api Google yang didukung, dan hanya beberapa alat yang mendukungnya. Untuk menjalankan dukungan ini, Anda perlu mengkompilasi target cloudJar dengan gradle:

./gradlew cloudJar

kemudian jalankan picard sebagai berikut:

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

Misalnya:

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

Alternatifnya, Anda dapat menjalankan alat tersebut melalui GATK yang menggabungkan toples Google-Cloud, dan dengan demikian seharusnya "Berfungsi".

---

Mengutip

Harap kutip repositori ini saat menggunakan alat Picard untuk publikasi Anda.

“Perangkat Picard.” 2019. Institut Luas, Repositori GitHub. https://broadinstitute.github.io/picard/; Institut Luas

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

Pengidentifikasi dari registrasi perangkat lunak semakin diterima oleh jurnal, seperti di (biotools:picard_tools) atau (RRID:SCR_006525).

Picard bermigrasi ke versi semantik. Kami pada akhirnya akan mematuhinya dengan ketat dan mengubah versi utama kami setiap kali ada perubahan yang dapat menyebabkan gangguan pada API kami, namun hingga kami dapat mendefinisikan dengan lebih jelas apa yang dimaksud dengan API resmi kami, klien harus berasumsi bahwa setiap rilis berpotensi berisi setidaknya perubahan kecil pada metode publik.

Silakan lihat Dokumentasi Picard untuk informasi lebih lanjut.