picard

Suporte ao usuário:

Para perguntas dos usuários, procure as respostas e pergunte primeiro no fórum GATK.

---

Um conjunto de ferramentas de linha de comando Java para manipular dados e formatos de sequenciamento de alto rendimento (HTS).

Picard é implementado usando a biblioteca Java HTSJDK HTSJDK para suportar o acesso a formatos de arquivo que são comumente usados ​​para dados de sequenciamento de alto rendimento, como SAM e VCF.

A partir da versão 3.0, Picard requer Java 1.17.

Edifício Picard

• Primeiro, clone o repositório:

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

• Picard agora é construído usando gradle. Um script wrapper ( gradlew ) está incluído e fará o download da versão apropriada do gradle na primeira invocação.

• Para construir um jar Picard totalmente empacotado e executável com todas as dependências incluídas, execute:

    ./gradlew shadowJar

• O jar resultante estará em build/libs . Para executá-lo, o comando é:

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

• Para construir um jar contendo apenas classes Picard (sem suas dependências), execute:

    ./gradlew jar

• Para limpar o diretório de compilação, execute:

    ./gradlew clean

Executando testes

• Para executar todos os testes, o comando é:

    ./gradlew test

• Para executar um teste específico, o comando é:

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

A execução legacyTest usa o analisador de linha de comando herdado, enquanto barclayTest usa o novo analisador.

Alterando a versão lançada do HTSJDK da qual Picard depende

Para mudar a dependência HTSJDK de Picard para uma versão lançada diferente:

• Abra build.gradle
• Edite VERSION na linha a seguir para ser uma versão lançada diferente do HTSJDK. Os lançamentos HTSJDK estão listados aqui

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

• Abra uma solicitação pull com esta alteração

Construindo Picard com uma versão personalizada do HTSJDK

Durante o desenvolvimento em Picard, às vezes é necessário compilar localmente em uma versão ou ramificação não lançada do HTSJDK.

• Para construir em uma versão não lançada do branch master do HTSJDK:

  • Vá para o artefato Broad, onde são publicados instantâneos contínuos do branch master do HTSJDK, e selecione a versão que deseja usar. Por exemplo, 2.5.1-9-g5740ca1-SNAPSHOT . Você pode pesquisar por tag ou hash curto de commit do git.
  • Em seu clone Picard, execute ./gradlew shadowJar -Dhtsjdk.version=VERSION , onde VERSION é a versão do snapshot do branch master HTSJDK que você deseja usar.

• Para compilar em uma versão do HTSJDK que ainda não foi mesclada na ramificação master do HTSJDK:

  • Clone HTSJDK e, em seu clone, verifique a tag ou branch com a qual deseja construir o Picard.
  • Execute ./gradlew install printVersion em seu clone htsjdk para instalar essa versão em seu repositório maven local. Anote o número da versão que é impresso no final.
  • Volte para o seu clone Picard e execute ./gradlew shadowJar -Dhtsjdk.version=VERSION , onde VERSION é a versão do HTSJDK que você instalou em seu repositório maven local.

Liberando Picard

Instruções completas sobre como criar uma nova versão do Picard estão aqui

Provedores de caminho

Picard tem suporte limitado para leitura de provedores Path. Atualmente, apenas a API do Google é suportada e apenas algumas ferramentas suportam isso. Para executar com este suporte você precisa compilar o destino cloudJar com gradle:

./gradlew cloudJar

em seguida, execute picard da seguinte maneira:

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

Por exemplo:

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

Alternativamente, você pode executar a ferramenta através do GATK que agrupa o jar Google-Cloud e deve, portanto, "Just Work".

---

Citando

Por favor, cite este repositório ao usar ferramentas Picard para suas publicações.

“Kit de ferramentas Picard.” 2019. Broad Institute, Repositório GitHub. https://broadinstitute.github.io/picard/; Instituto Amplo

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

Identificadores de registros de software são cada vez mais aceitos pelos periódicos, como em (biotools:picard_tools) ou (RRID:SCR_006525).

Picard está migrando para versionamento semântico. Eventualmente, iremos aderi-lo estritamente e alterar nossa versão principal sempre que houver alterações significativas em nossa API, mas até definirmos mais claramente o que constitui nossa API oficial, os clientes devem assumir que cada versão contém potencialmente pelo menos pequenas alterações nos métodos públicos.

Consulte a documentação do Picard para obter mais informações.