fastani

Tags: ani average-nucleotide-identity similarity comparative-genomics bactopia-tool

Cálculo rápido e sem alinhamento da Identidade Nucleotídica Média (ANI) em escala genômica.

Esta Ferramenta Bactopia utiliza o FastANI para calcular a identidade nucleotídica média (ANI) entre amostras. Também é possível calcular o ANI em relação a genomas de referência, baixando montagens do RefSeq via NCBI genome download.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

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

Resultados por Amostra

Arquivo	Descrição
*.tsv	Resultados do FastANI das amostras em relação à referência

Resultados Consolidados

Arquivo	Descrição
fastani.tsv	Arquivo TSV consolidado com os resultados de ANI de todas as amostras

Trilha de Auditoria

Abaixo estão os arquivos que podem ajudar 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 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 definido
.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 execução. Podem ser usados para otimizar o uso de recursos e estimar custos esperados em plataformas de nuvem.

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

Parâmetros

Parâmetros Obrigatórios

Define onde o pipeline deve buscar 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 do fastANI

Parâmetro	Tipo	Padrão	Descrição
--fastani_reference	string		Caminho para o genoma de referência no formato FASTA
--fastani_kmer	integer	16	Tamanho do kmer (<= 16) para cálculo do ANI
--fastani_min_fraction	number	0.2	Fração mínima do genoma que deve ser compartilhada para confiar no ANI.
--fastani_frag_len	integer	3000	Tamanho do fragmento
--fastani_skip_pairwise	boolean	false	Usar apenas montagens do RefSeq ou locais para cálculos de ANI

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 do NCBI Genome Download

Parâmetro	Tipo	Padrão	Descrição
--species	string		Nome da espécie para baixar as montagens
--accession	string		Um número de acesso de montagem do NCBI a ser baixado
--accessions	string		Um arquivo com números de acesso de montagens do NCBI (um por linha) a serem baixados
--format	string	fasta	Lista de formatos a serem baixados, separados por vírgula
--section	string	refseq	Seção do NCBI para download
--assembly_level	string	complete	Lista de níveis de montagem a serem baixados, separados por vírgula
--kingdom	string	bacteria	Lista de formatos a serem baixados, separados por vírgula
--limit	string		Limitar o número de montagens a serem baixadas
--keep_downloads	boolean	false	Salvar os arquivos baixados na pasta bactopia-runs

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 com nomes de amostras (um por linha) a serem incluídas na análise
--exclude	string		Um arquivo de texto com 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 datasets em cache
--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 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 a serem baixadas por vez

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 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 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 ambientes Conda
--registry	string	quay.io	Registro de onde 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 imagens Singularity diretamente, 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) a serem usadas pelo agendador de jobs, separados por vírgula (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 de executar.
--validate_params	boolean	true	Define se os parâmetros devem ser validados 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 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 texto de versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• fastani - Calcula a Identidade Nucleotídica Média (ANI) entre genomas.
• ncbigenomedownload - Baixa genomas bacterianos do banco de dados RefSeq do NCBI.

Citações

Se você usar este fluxo de trabalho 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)

• FastANI
  Jain C, Rodriguez-R LM, Phillippy AM, Konstantinidis KT, Aluru S High throughput ANI analysis of 90K prokaryotic genomes reveals clear species boundaries. Nat. Commun. 9, 5114 (2018)

Fonte

Ver fonte no GitHub