Pular para o conteúdo principal

abricate

Tags: bacteria antimicrobial-resistance virulence screening bactopia-tool

Triagem em massa de contigs para genes de resistência antimicrobiana e virulência.

Esta Bactopia Tool utiliza o Abricate para triagem de montagens contra múltiplos bancos de dados de genes de resistência e virulência, incluindo NCBI, CARD, RESFINDER, ARG-ANNOT, VFDB, PLASMIDFINDER, ECOLI_VF e MEGARES. O processo analisa um diretório de resultados do Bactopia, executa o Abricate em cada amostra e cria um relatório de resumo consolidado.

Uso​

Execute com o banco de dados CARD para detecção de genes de resistência antimicrobiana:

Bactopia CLI:

bactopia --wf abricate \
  --bactopia /path/to/your/bactopia/results \
  --abricate_db card

Nextflow:

nextflow run bactopia/bactopia/workflows/bactopia-tools/abricate/main.nf \
  --bactopia /path/to/your/bactopia/results \
  --abricate_db card
Dica

Você pode executar este fluxo de trabalho várias vezes com diferentes bancos de dados para realizar a triagem em todos eles. Cada execução produzirá resultados separados que podem ser comparados.

Saídas​

Arquivos de Saída Esperados​

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── abricate
│           └── ncbi
│               ├── <SAMPLE_NAME>.tsv
│               └── logs
│                   ├── nf.command.{begin,err,log,out,run,sh,trace}
│                   └── versions.yml
└── bactopia-runs
    └── abricate-ncbi-<TIMESTAMP>
        ├── merged-results
        │   ├── abricate-ncbi.tsv
        │   └── logs
        │       └── abricate-concat
        │           └── ncbi
        │               ├── nf.command.{begin,err,log,out,run,sh,trace}
        │               └── versions.yml
        └── nf-reports
            ├── abricate-dag.dot
            ├── abricate-report.html
            └── abricate-timeline.html

Resultados por Amostra​

ArquivoDescrição
*.tsvRelatório delimitado por tabulação com os resultados da triagem do Abricate para cada amostra

Resultados Consolidados​

ArquivoDescrição
abricate.tsvRelatório TSV consolidado contendo os resultados do Abricate de todas as amostras

Trilha de Auditoria​

A seguir estão os arquivos que podem ajudar você a entender quais parâmetros e versões de programas foram utilizados.

Logs​

Cada processo executado terá uma pasta chamada logs. Nesta pasta estão arquivos úteis para consulta caso necessário.

ExtensãoDescrição
.beginArquivo vazio utilizado para indicar que o processo foi iniciado
.errContém as saídas STDERR do processo
.logContém as saídas STDERR e STDOUT do processo
.outContém as saídas STDOUT do processo
.runO script que o Nextflow usa para preparar/remover arquivos e enfileirar processos com base no perfil definido
.shO script executado pelo bash para o processo
.traceO relatório de rastreamento do Nextflow para o processo
versions.ymlArquivo no formato YAML com as versões dos programas

Relatórios do Nextflow​

Estes relatórios do Nextflow fornecem um excelente resumo da sua execução. Eles podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas em nuvem.

ArquivoDescrição
abricate-dag.dotA visualização DAG do Nextflow
abricate-report.htmlO Relatório de Execução do Nextflow
abricate-timeline.htmlO Relatório de Linha do Tempo do Nextflow
abricate-trace.txtO relatório de Rastreamento do Nextflow

Parâmetros​

Parâmetros Obrigatórios​

Defina onde o pipeline deve encontrar os dados de entrada e salvar os dados de saída.

ParâmetroTipoPadrãoDescrição
--bactopiastringO caminho para os resultados do bactopia a serem usados como entrada

Parâmetros do Abricate​

ParâmetroTipoPadrãoDescrição
--abricate_dbstringncbiBanco de dados a ser utilizado
--abricate_minidinteger80Percentual mínimo de identidade de DNA
--abricate_mincovinteger80Percentual mínimo de cobertura de DNA
Parâmetros de Filtragem

Use estes parâmetros para especificar quais amostras incluir ou excluir.

ParâmetroTipoPadrãoDescrição
--includestringUm arquivo de texto contendo nomes de amostras (um por linha) a serem incluídas na análise
--excludestringUm arquivo de texto contendo nomes de amostras (um por linha) a serem excluídas da análise
Parâmetros Opcionais

Estes parâmetros opcionais podem ser úteis em determinadas situações.

ParâmetroTipoPadrãoDescrição
--outdirstringbactopiaDiretório base para salvar os resultados
--skip_compressionbooleanfalseOs arquivos de saída não serão comprimidos
--datasetsstringO caminho para armazenar em cache os datasets
--keep_all_filesbooleanfalseMantém todos os arquivos de análise criados
Parâmetros de Limite Máximo de Recursos

Define o limite máximo de recursos solicitados para qualquer job individual.

ParâmetroTipoPadrãoDescrição
--max_retryinteger3Número máximo de tentativas de um processo antes de permitir que ele falhe.
--max_cpusinteger4Número máximo de CPUs que podem ser solicitadas para qualquer job individual.
--max_memorystring128.GBQuantidade máxima de memória que pode ser solicitada para qualquer job individual.
--max_timestring240.hTempo máximo que pode ser solicitado para qualquer job individual.
--max_downloadsinteger3Número máximo de amostras a serem baixadas ao mesmo tempo
Parâmetros de Configuração do Nextflow

Parâmetros para ajustar a configuração do Nextflow.

ParâmetroTipoPadrãoDescrição
--nfconfigstringUm arquivo de configuração compatível com Nextflow para perfis personalizados, carregado por último e que substituirá variáveis existentes se definido.
--publish_dir_modestringcopyMétodo usado para salvar os resultados do pipeline no diretório de saída. (opções: symlink, rellink, link, copy, copyNoFollow, move)
--infodirstring${params.outdir}/pipeline_infoDiretório para manter os logs e relatórios do Nextflow do pipeline.
--forcebooleanfalseO Nextflow sobrescreverá arquivos de saída existentes.
--cleanup_workdirbooleanfalseApós a execução bem-sucedida do Bactopia, o diretório work será excluído.
Opções de configuração institucional

Parâmetros usados para descrever perfis de configuração centralizados. Estes não devem ser editados.

ParâmetroTipoPadrãoDescrição
--custom_config_versionstringmasterID de commit Git para configurações institucionais.
--custom_config_basestringhttps://raw.githubusercontent.com/nf-core/configs/masterDiretório base para configurações institucionais.
--config_profile_namestringNome do perfil de configuração institucional.
--config_profile_descriptionstringDescrição do perfil de configuração institucional.
--config_profile_contactstringInformações de contato do perfil de configuração institucional.
--config_profile_urlstringURL do perfil de configuração institucional.
Parâmetros de Perfil do Nextflow

Parâmetros para ajustar a configuração do Nextflow.

ParâmetroTipoPadrãoDescrição
--condadirstringDiretório que o Nextflow deve usar para os ambientes Conda
--registrystringquay.ioRegistro de onde os contêineres Docker serão baixados.
--datasets_cachestring<HOME>/.bactopia/datasetsDiretório onde os datasets baixados devem ser armazenados.
--singularity_cachestringDiretório onde as imagens Singularity remotas são armazenadas.
--singularity_pull_docker_containerbooleanEm vez de baixar imagens Singularity diretamente, força o fluxo de trabalho a baixar e converter contêineres Docker.
--force_rebuildbooleanfalseForça a substituição de ambientes pré-construídos existentes.
--queuestringgeneral,high-memoryNome(s) da(s) fila(s) separados por vírgula a serem usados por um agendador de jobs (ex.: AWS Batch ou SLURM)
--cluster_optsstringOpções adicionais a serem passadas ao executor. (ex.: SLURM: '--account=my_acct_name'
--container_optsstringOpções adicionais a serem passadas ao Apptainer, Docker ou Singularity. (ex.: Singularity: '-D pwd'
--disable_scratchbooleanfalseTodos os arquivos intermediários criados nos nós de trabalho serão transferidos para o nó principal.
Parâmetros Úteis

Parâmetros raramente usados que podem ser úteis em alguns casos.

ParâmetroTipoPadrãoDescrição
--monochrome_logsbooleanNão usar saídas de log coloridas.
--nfdirbooleanExibe o diretório para o qual o Nextflow baixou o Bactopia
--sleep_timeinteger5O tempo (em segundos) que o Nextflow aguardará após configurar os datasets antes da execução.
--validate_paramsbooleantrueDefine se os parâmetros devem ser validados em relação ao esquema em tempo de execução
--helpbooleanExibe o texto de ajuda.
--wfstringbactopiaEspecifica qual fluxo de trabalho ou Bactopia Tool executar
--list_wfsbooleanLista os fluxos de trabalho e Bactopia Tools disponíveis para uso com '--wf'
--show_hidden_paramsbooleanMostra todos os parâmetros ao usar --help
--help_allbooleanUm alias para --help --show_hidden_params
--versionbooleanExibe o texto da versão.

Composição​

Este fluxo de trabalho utiliza os seguintes subworkflows:

  • abricate - Triagem em massa de contigs para genes de resistência antimicrobiana e virulência.

Citações​

Se você usar este fluxo de trabalho em sua análise, por favor cite os seguintes trabalhos.

Fonte​

Ver fonte no GitHub