checkm2

Tags: assembly-quality microbial-genomes machine-learning completeness bactopia-tool

Avaliação baseada em aprendizado de máquina da qualidade de montagem de genomas microbianos.

Esta Ferramenta Bactopia utiliza o CheckM2 para avaliar a qualidade de genomas microbianos obtidos a partir de isolados, células individuais e metagenomas, usando abordagens avançadas de aprendizado de máquina.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

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

Avaliação de Qualidade

Arquivo	Descrição
diamond_output/**	Diretório com resultados intermediários do processamento pelo CheckM2
protein_files/**	Diretório contendo arquivos de proteínas usados na análise
quality_report.tsv	Arquivo de saída com estatísticas de completude

Resultados Combinados

Arquivo	Descrição
checkm2.tsv	Arquivo TSV combinado com os resultados do CheckM2 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. Nessa pasta estão arquivos úteis para você revisar 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/remover arquivos e enfileirar processos com base no perfil definido
.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
checkm2-dag.dot	A visualização DAG do Nextflow
checkm2-report.html	O Relatório de Execução do Nextflow
checkm2-timeline.html	O Relatório de Linha do Tempo do Nextflow
checkm2-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 Download do Banco de Dados do CheckM2

Parâmetro	Tipo	Padrão	Descrição
--checkm2_db	string		Caminho para uma pasta contendo o banco de dados do CheckM2 (ou onde ele deve ser baixado).
--download_checkm2	boolean	false	Baixa o banco de dados do CheckM2 para o caminho indicado por --checkm2_db

Parâmetros do CheckM2

Parâmetro	Tipo	Padrão	Descrição
--checkm2_lowmem	boolean		Modo de baixo consumo de memória. Reduz o tamanho do bloco do DIAMOND para diminuir significativamente o uso de RAM, em troca de maior tempo de execução
--checkm2_general	boolean		Força o uso do modelo geral de predição de qualidade (gradient boost)
--checkm2_specific	boolean		Força o uso do modelo específico de predição de qualidade (rede neural)
--checkm2_allmodels	boolean		Gera a predição de qualidade para ambos os modelos para cada genoma.
--checkm2_genes	boolean		Trata os arquivos de entrada como arquivos de proteínas. [Padrão: False]
--checkm2_opts	string		Opções adicionais a serem passadas para o CheckM2

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 esses 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

Esses 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 ao mesmo tempo

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 o Nextflow para perfis personalizados, carregado por último e que sobrescreverá 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 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		Link de 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 os ambientes Conda
--registry	string	quay.io	Registro do qual os contêineres 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 as imagens Singularity, força o fluxo de trabalho a baixar e converter contêineres 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 por um agendador de jobs (ex.: AWS Batch ou SLURM)
--cluster_opts	string		Opções adicionais a serem passadas para o executor. (ex.: SLURM: '--account=my_acct_name'
--container_opts	string		Opções adicionais a serem passadas para 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 utiliza saídas de log coloridas.
--nfdir	boolean		Exibe 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	Define se os parâmetros devem ser validados em relação ao esquema em tempo de execução
--help	boolean		Exibe o texto de ajuda.
--wf	string	bactopia	Especifica qual fluxo de trabalho ou Ferramenta Bactopia executar
--list_wfs	boolean		Lista os fluxos de trabalho e Ferramentas Bactopia disponíveis para uso com '--wf'
--show_hidden_params	boolean		Mostra todos os parâmetros ao usar --help
--help_all	boolean		Um alias para --help --show_hidden_params
--version	boolean		Exibe o texto da versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• checkm2 - Avalia a completude de bins de metagenoma usando CheckM2.

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)

• CheckM2
  Chklovksi A Rapid assessment of genome bin quality using machine learning (GitHub)

Fonte

Ver fonte no GitHub