picardダウンロード - picardソースコードのダウンロード

picard

その他のソースコード

3.3.0

ダウンロード

ユーザーサポート:

ユーザーからの質問については、GATK フォーラムで答えを探して質問してください。

ビルドステータス

ハイスループットシーケンス (HTS) データと形式を操作するための Java コマンドラインツールのセット。

Picard は、SAM や VCF などの高スループットシーケンスデータに一般的に使用されるファイル形式へのアクセスをサポートするために、HTSJDK Java ライブラリ HTSJDK を使用して実装されています。

バージョン 3.0 では、Picard には Java 1.17 が必要です。

ピカードの建物

まず、リポジトリのクローンを作成します。

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

Picard は gradle を使用して構築されるようになりました。最初の呼び出し時に適切なバージョンの gradle をダウンロードするラッパースクリプト ( gradlew ) が含まれています。
すべての依存関係を含む、完全にパッケージ化された実行可能な 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 のマスターブランチの未リリースバージョンに対してビルドするには:
- HTSJDK の master ブランチの連続スナップショットが公開されている Broad アーティファクトリに移動し、使用するバージョンを選択します。たとえば、 2.5.1-9-g5740ca1-SNAPSHOT 。タグまたは短い Git コミットハッシュで検索できます。
- Picard クローンで、 ./gradlew shadowJar -Dhtsjdk.version=VERSIONを実行します。ここで、 VERSION は、使用する HTSJDK マスターブランチスナップショットのバージョンです。
HTSJDK の master ブランチにまだマージされていない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 経由でツールを実行することもできるため、「そのまま動作」するはずです。

引用

出版物に Picard ツールを使用する場合は、このリポジトリを引用してください。

「ピカードツールキット」 2019. Broad Institute、GitHub リポジトリ。 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 のドキュメントを参照してください。

拡大する

追加情報