gtdb

Tags: taxonomy classification marker-genes phylogeny gtdb bactopia-tool

Identifique genes marcadores e atribua classificações taxonômicas usando GTDB.

Esta Ferramenta Bactopia utiliza o fluxo de trabalho de classificação do GTDB-Tk para atribuir classificações taxonômicas às amostras usando o Genome Taxonomy Database.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── gtdb-<TIMESTAMP>
│           ├── <SAMPLE_NAME>.bac120.summary.tsv
│           ├── logs
│           │   ├── gtdbtk.log
│           │   ├── gtdbtk.warnings.log
│           │   ├── nf.command.{begin,err,log,out,run,sh,trace}
│           │   └── versions.yml
│           └── supplemental
│               ├── classify
│               │   └── ani_screen
│               │       └── <SAMPLE_NAME>.bac120.ani_summary.tsv
│               └── gtdbtk.json
└── bactopia-runs
    └── gtdb-<TIMESTAMP>
        ├── merged-results
        │   ├── gtdb.tsv
        │   └── logs
        │       └── gtdb-concat
        │           ├── nf.command.{begin,err,log,out,run,sh,trace}
        │           └── versions.yml
        └── nf-reports
            ├── gtdb-dag.dot
            ├── gtdb-report.html
            └── gtdb-timeline.html

Classificação Taxonômica

Arquivo	Descrição
*.summary.tsv	Resumo da classificação taxonômica
*.gtdbtk.tsv	Resultados detalhados do GTDB-Tk

Resultados Consolidados

Arquivo	Descrição
gtdb.tsv	Arquivo TSV consolidado contendo resultados do GTDB de 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. Nessa pasta estão arquivos úteis para revisão, caso necessário.

Extensão	Descrição
.begin	Um 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/desmontar 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	Um 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. Eles podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas em nuvem.

Nome do Arquivo	Descrição
gtdb-dag.dot	A visualização DAG do Nextflow
gtdb-report.html	O Relatório de Execução do Nextflow
gtdb-timeline.html	O Relatório de Linha do Tempo do Nextflow
gtdb-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 de Configuração do Banco de Dados GTDB-Tk

Parâmetro	Tipo	Padrão	Descrição
--gtdb	string		Tarball ou caminho de um banco de dados GTDB. Se um banco de dados não for encontrado, você deve usar '--download_gtdb'
--download_gtdb	boolean	false	Baixar o banco de dados GTDB mais recente, mesmo que já exista
--gtdb_save_as_tarball	boolean	false	Baixar o banco de dados GTDB mais recente e salvá-lo em um único tarball

Parâmetros de Classificação GTDB

Parâmetro	Tipo	Padrão	Descrição
--gtdb_min_af	number	0.65	Fração mínima de alinhamento para considerar o genoma mais próximo
--gtdb_min_perc_aa	integer	10	Filtrar genomas com uma porcentagem insuficiente de AA no MSA
--gtdb_tmp	string	/tmp	Especificar diretório alternativo para arquivos temporários
--gtdb_use_scratch	boolean	false	Reduzir o uso de memória do pplacer escrevendo no local --gtdb_tmp (mais lento)
--gtdb_debug	boolean	false	Criar arquivos intermediários para fins de depuração
--gtdb_keep_msa	boolean	false	Manter o arquivo MSA para todos os genomas submetidos e de referência
--force_gtdb	boolean	false	Continuar o processamento se ocorrer um erro em um único genoma

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 Requisição Máxima 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 irá 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 de 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 da configuração institucional.
--config_profile_description	string		Descrição da configuração institucional.
--config_profile_contact	string		Informações de contato da configuração institucional.
--config_profile_url	string		Link URL da 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 os ambientes Conda
--registry	string	quay.io	Registro de onde os containers Docker serão baixados.
--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 para uso com Singularity, forçar o fluxo de trabalho a baixar e converter containers Docker.
--force_rebuild	boolean	false	Forçar 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 por um agendador de jobs (ex.: AWS Batch ou SLURM)
--cluster_opts	string		Opções adicionais a serem passadas ao executor. (ex.: SLURM: '--account=my_acct_name'
--container_opts	string		Opções adicionais a serem passadas 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	O tempo (em 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 o texto de ajuda.
--wf	string	bactopia	Especificar qual fluxo de trabalho ou Ferramenta Bactopia executar
--list_wfs	boolean		Listar os fluxos de trabalho e Ferramentas Bactopia 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 o texto da versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• gtdb - Classificação taxonômica com o Genome Taxonomy Database.

Citações

Se você usar isso em sua análise, por favor cite o seguinte.

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

• Genome Taxonomy Database
  Parks DH, Chuvochina M, Rinke C, Mussig AJ, Chaumeil P-A, Hugenholtz P GTDB: an ongoing census of bacterial and archaeal diversity through a phylogenetically consistent, rank normalized and complete genome-based taxonomy Nucleic Acids Research gkab776 (2021)

Fonte

Ver fonte no GitHub