rgi

Tags: bacteria antibiotic-resistance card resistance-genes bactopia-tool

Previsão de genes de resistência a antibióticos usando RGI.

Esta Bactopia Tool utiliza o Resistance Gene Identifier (RGI) para identificar e caracterizar genes de resistência a antibióticos em montagens bacterianas. O RGI integra-se com o Comprehensive Antibiotic Resistance Database (CARD) para fornecer previsões de alta confiança de determinantes de resistência, incluindo hits perfeitos e estritos a genes de resistência conhecidos, bem como hits soltos para variantes novas. A ferramenta gera relatórios detalhados nos formatos JSON e TSV, além de visualizações em mapa de calor para análise comparativa entre múltiplas amostras.

Uso

Bactopia CLI:

bactopia --wf rgi \
  --bactopia /path/to/your/bactopia/results

Nextflow:

nextflow run bactopia/bactopia/workflows/bactopia-tools/rgi/main.nf \
  --bactopia /path/to/your/bactopia/results

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── rgi_main
│           ├── <SAMPLE_NAME>.json
│           ├── <SAMPLE_NAME>.tsv
│           └── logs
│               ├── nf.command.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
├── GCF_900478275
│   └── tools
│       └── rgi_main
│           ├── GCF_900478275.json
│           ├── GCF_900478275.tsv
│           └── logs
│               ├── nf.command.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
└── bactopia-runs
    └── rgi-<TIMESTAMP>
        ├── merged-results
        │   ├── logs
        │   │   └── rgi-concat
        │   │       ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │       └── versions.yml
        │   └── rgi.tsv
        ├── nf-reports
        │   ├── rgi-dag.dot
        │   ├── rgi-report.html
        │   └── rgi-timeline.html
        └── rgi-heatmap
            ├── logs
            │   └── rgi-heatmap
            │       ├── nf.command.{begin,err,log,out,run,sh,trace}
            │       └── versions.yml
            ├── rgi-2.csv
            ├── rgi-2.eps
            └── rgi-2.png

Resultados por Amostra

Arquivo	Descrição
*.json	Relatório JSON contendo resultados detalhados do RGI para cada amostra
*.txt	Relatório delimitado por tabulação dos resultados do RGI para cada amostra

Resultados Consolidados

Arquivo	Descrição
rgi.tsv	Arquivo TSV consolidado contendo os resultados do RGI de todas as amostras
rgi-2.{csv,png}	Representações em mapa de calor dos genes de resistência em todas as amostras

Trilha de Auditoria

Abaixo estão os arquivos que podem ajudá-lo 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ão	Descrição
.begin	Arquivo vazio usado para indicar que o processo foi iniciado
.err	Contém as saídas STDERR do processo
.log	Contém as saídas STDERR e STDOUT do processo
.out	Contém as saídas STDOUT do processo
.run	O script que o Nextflow usa para preparar/remover arquivos e enfileirar processos com base no perfil fornecido
.sh	O script executado pelo bash para o processo
.trace	O relatório de rastreamento do Nextflow para o processo
versions.yml	Arquivo no formato YAML com as versões dos programas

Relatórios do Nextflow

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

Arquivo	Descrição
rgi-dag.dot	A visualização DAG do Nextflow
rgi-report.html	O Relatório de Execução do Nextflow
rgi-timeline.html	O Relatório de Linha do Tempo do Nextflow
rgi-trace.txt	O relatório de Rastreamento do Nextflow

Parâmetros

Parâmetros Obrigatórios

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

Parâmetro	Tipo	Padrão	Descrição
--bactopia	string		O caminho para os resultados do bactopia a serem usados como entradas

Parâmetros Principais do RGI

Parâmetro	Tipo	Padrão	Descrição
--rgi_use_diamond	boolean	false	Usar DIAMOND para alinhamentos em vez de BLAST
--rgi_include_loose	boolean	false	Incluir hits soltos além dos hits estritos e perfeitos
--rgi_exclude_nudge	boolean	false	Excluir hits promovidos de soltos para estritos
--rgi_frequency	boolean	false	Representar amostras com base no perfil de resistência
--rgi_category	string		Organizar genes de resistência com base em uma categoria (opções: drug_class, resistance_mechanism, gene_family)
--rgi_cluster	string		Usar o algoritmo de agrupamento hierárquico do SciPy para agrupar linhas (genes AMR) ou colunas (amostras) (opções: samples, genes, both)
--rgi_display	string	plain	Especificar opções de exibição para categorias (opções: plain, fill, text)

Parâmetros do csvtk concat

Parâmetro	Tipo	Padrão	Descrição
--csvtk_concat_opts	string		Opções extras do csvtk concat entre aspas

Parâmetros de Filtragem

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

Parâmetro	Tipo	Padrão	Descrição
--include	string		Um arquivo de texto contendo nomes de amostras (um por linha) a serem incluídas na análise
--exclude	string		Um 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âmetro	Tipo	Padrão	Descrição
--outdir	string	bactopia	Diretório base para salvar os resultados
--skip_compression	boolean	false	Os arquivos de saída não serão comprimidos
--datasets	string		O caminho para armazenar em cache os datasets
--keep_all_files	boolean	false	Mantém todos os arquivos de análise criados

Parâmetros de Limite Máximo de Jobs

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

Parâmetro	Tipo	Padrão	Descrição
--max_retry	integer	3	Número máximo de tentativas de um processo antes de permitir que ele falhe.
--max_cpus	integer	4	Número máximo de CPUs que podem ser solicitadas para qualquer job individual.
--max_memory	string	128.GB	Quantidade máxima de memória que pode ser solicitada para qualquer job individual.
--max_time	string	240.h	Tempo máximo que pode ser solicitado para qualquer job individual.
--max_downloads	integer	3	Número máximo de amostras para baixar simultaneamente

Parâmetros de Configuração do Nextflow

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

Parâmetro	Tipo	Padrão	Descrição
--nfconfig	string		Um arquivo de configuração compatível com Nextflow para perfis personalizados, carregado por último e que substituirá variáveis existentes se definido.
--publish_dir_mode	string	copy	Método usado para salvar os resultados do pipeline no diretório de saída. (opções: symlink, rellink, link, copy, copyNoFollow, move)
--infodir	string	${params.outdir}/pipeline_info	Diretório para manter os logs e relatórios do Nextflow do pipeline.
--force	boolean	false	O Nextflow sobrescreverá arquivos de saída existentes.
--cleanup_workdir	boolean	false	Apó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âmetro	Tipo	Padrão	Descrição
--custom_config_version	string	master	ID do commit Git para configurações institucionais.
--custom_config_base	string	https://raw.githubusercontent.com/nf-core/configs/master	Diretório base para configurações institucionais.
--config_profile_name	string		Nome do perfil de configuração institucional.
--config_profile_description	string		Descrição do perfil de configuração institucional.
--config_profile_contact	string		Informações de contato do perfil de configuração institucional.
--config_profile_url	string		URL do perfil de configuração institucional.

Parâmetros de Perfil do Nextflow

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

Parâmetro	Tipo	Padrão	Descrição
--condadir	string		Diretório que o Nextflow deve usar para ambientes Conda
--registry	string	quay.io	Registro para baixar containers Docker.
--datasets_cache	string	<HOME>/.bactopia/datasets	Diretório onde os datasets baixados devem ser armazenados.
--singularity_cache	string		Diretório onde as imagens Singularity remotas são armazenadas.
--singularity_pull_docker_container	boolean		Em vez de baixar diretamente imagens Singularity, força o fluxo de trabalho a baixar e converter containers Docker.
--force_rebuild	boolean	false	Força a sobrescrita de ambientes pré-construídos existentes.
--queue	string	general,high-memory	Nome(s) da(s) fila(s) separados por vírgula a serem usados pelo agendador de jobs (ex.: AWS Batch ou SLURM)
--cluster_opts	string		Opções adicionais para passar ao executor. (ex.: SLURM: '--account=my_acct_name'
--container_opts	string		Opções adicionais para passar ao Apptainer, Docker ou Singularity. (ex.: Singularity: '-D pwd'
--disable_scratch	boolean	false	Todos 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.

Parâmetro	Tipo	Padrão	Descrição
--monochrome_logs	boolean		Não usar saídas de log coloridas.
--nfdir	boolean		Exibir o diretório para o qual o Nextflow baixou o Bactopia
--sleep_time	integer	5	A quantidade de tempo (segundos) que o Nextflow aguardará após configurar os datasets antes da execução.
--validate_params	boolean	true	Booleano para validar os parâmetros em relação ao esquema em tempo de execução
--help	boolean		Exibir texto de ajuda.
--wf	string	bactopia	Especificar qual fluxo de trabalho ou Bactopia Tool executar
--list_wfs	boolean		Listar os fluxos de trabalho e Bactopia Tools disponíveis para uso com '--wf'
--show_hidden_params	boolean		Mostrar todos os parâmetros ao usar --help
--help_all	boolean		Um alias para --help --show_hidden_params
--version	boolean		Exibir texto da versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• rgi - Prever resistência antimicrobiana a partir de dados proteicos ou nucleotídicos.

Citações

Se você usar isso em sua análise, por favor cite os seguintes trabalhos.

• Bactopia
  Petit III RA, Read TD Bactopia - a flexible pipeline for complete analysis of bacterial genomes. mSystems 5 (2020)

• csvtk
  Shen, W csvtk: A cross-platform, efficient and practical CSV/TSV toolkit in Golang. (GitHub)

• Resistance Gene Identifier (RGI)
  Alcock BP, Raphenya AR, Lau TTY, Tsang KK, Bouchard M, Edalatmand A, Huynh W, Nguyen A-L V, Cheng AA, Liu S, Min SY, Miroshnichenko A, Tran H-K, Werfalli RE, Nasir JA, Oloni M, Speicher DJ, Florescu A, Singh B, Faltyn M, Hernandez-Koutoucheva A, Sharma AN, Bordeleau E, Pawlowski AC, Zubyk HL, Dooley D, Griffiths E, Maguire F, Winsor GL, Beiko RG, Brinkman FSL, Hsiao WWL, Domselaar GV, McArthur AG CARD 2020: antibiotic resistome surveillance with the comprehensive antibiotic resistance database. Nucleic acids research 48.D1, D517-D525 (2020)

Fonte

Ver fonte no GitHub