picard

用戶支援：

對於使用者問題，請先在 GATK 論壇中尋找答案並提出問題。

---

一組用於操作高通量定序 (HTS) 資料和格式的 Java 命令列工具。

Picard 使用 HTSJDK Java 函式庫 HTSJDK 實現，支援存取高通量定序資料常用的檔案格式，例如 SAM 和 VCF。

從版本 3.0 開始，Picard 需要 Java 1.17。

建築皮卡德

• 首先，克隆儲存庫：

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

• Picard 現在使用 gradle 建置。其中包含一個包裝腳本 ( gradlew )，它將在第一次呼叫時下載適當版本的 gradle。

• 若要建置包含所有相依性的完全打包、可執行的 Picard jar，請執行：

    ./gradlew shadowJar

• 產生的 jar 將位於build/libs中。要運行它，命令是：

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

• 若要建置僅包含 Picard 類別（不包含其相依性）的 jar，請執行：

    ./gradlew jar

• 要清理建置目錄，請執行：

    ./gradlew clean

運行測試

• 要執行所有測試，命令是：

    ./gradlew test

• 要執行特定測試，命令是：

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

運行legacyTest使用舊版命令列解析器，而barclayTest使用新解析器。

更改 Picard 依賴的 HTSJDK 的發布版本

要將 Picard 的 HTSJDK 依賴項切換到不同的發布版本：

• 打開build.gradle
• 將以下行中的 VERSION 編輯為 HTSJDK 的不同發行版本。此處列出了 HTSJDK 版本

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

• 使用此變更開啟拉取請求

使用自訂版本的 HTSJDK 建置 Picard

在 Picard 中進行開發期間，有時需要針對 HTSJDK 的未發布版本或分支進行本機建置。

• 要針對 HTSJDK 的 master 分支的未發布版本進行建置：

  • 轉到廣泛的工件，其中發布了 HTSJDK 主分支的連續快照，然後選擇您要使用的版本。例如， 2.5.1-9-g5740ca1-SNAPSHOT 。您可以透過標籤或短 git commit 哈希進行搜尋。
  • 在您的 Picard 克隆中，執行./gradlew shadowJar -Dhtsjdk.version=VERSION ，其中 VERSION 是您要使用的 HTSJDK 主分支快照的版本。

• 若要針對尚未合併到 HTSJDK 主分支的 HTSJDK 版本進行建置：

  • 克隆 HTSJDK，然後在克隆中檢查您想要用來建立 Picard 的標籤或分支。
  • 在 htsjdk 克隆中運行./gradlew install printVersion將該版本安裝到本機 Maven 儲存庫。記下最後列印的版本號。
  • 切換回 Picard 克隆，然後執行./gradlew shadowJar -Dhtsjdk.version=VERSION ，其中 VERSION 是您安裝到本機 Maven 儲存庫的 HTSJDK 版本。

釋放皮卡德

有關如何建立新版本的 Picard 的完整說明請參閱此處

路徑提供者

Picard 對從路徑提供者讀取的支援有限。目前僅支援google的api，並且只有少數工具支援此。要使用此支援運行，您需要使用 gradle 編譯 cloudJar 目標：

./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

或者，您可以透過捆綁 Google-Cloud jar 的 GATK 來運行該工具，因此應該「Just Work」。

---

引用

在您的出版品中使用 Picard 工具時，請引用此儲存庫。

“皮卡德工具包。” 2019。 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)。

Picard 正在遷移到語意版本控制。我們最終將嚴格遵守它，並在我們的API 發生重大更改時升級我們的主要版本，但在我們更清楚地定義我們的官方API 的構成之前，客戶應該假設每個版本都可能至少包含對公共方法的微小更改。

請參閱 Picard 文件以取得更多資訊。