mashdist

Tags: mash distance similarity comparative-genomics bactopia-tool

Calcule distâncias Mash entre sequências e genomas de referência.

Esta Ferramenta Bactopia usa o Mash para determinar a distância Mash de amostras em relação a sketches de genomas de referência para comparação genômica rápida.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

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

Resultados por Amostra

Arquivo	Descrição
*.txt	Resultados de distância Mash para cada amostra

Resultados Mesclados

Arquivo	Descrição
mashdist.tsv	Arquivo TSV mesclado contendo as distâncias Mash de todas as amostras

Trilha de Auditoria

Abaixo 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 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 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 formatado em YAML com as versões dos programas

Relatórios do Nextflow

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

Nome do Arquivo	Descrição
mashdist-dag.dot	A visualização DAG do Nextflow
mashdist-report.html	O Relatório de Execução do Nextflow
mashdist-timeline.html	O Relatório de Linha do Tempo do Nextflow
mashdist-trace.txt	O 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âmetro	Tipo	Padrão	Descrição
--bactopia	string		O caminho para os resultados do Bactopia a serem usados como entradas

Parâmetros do mashdist

Parâmetro	Tipo	Padrão	Descrição
--mash_sketch	string		A sequência de referência como um Mash Sketch (arquivo .msh)
--mash_seed	integer	42	Semente fornecida à função de hash
--mash_table	boolean	false	Saída em formato de tabela (os campos ficarão em branco se não atenderem ao limiar de p-valor)
--mash_m	integer	1	Número mínimo de cópias de cada k-mer necessário para passar no filtro de ruído para reads
--mash_w	number	0.01	Limiar de probabilidade para aviso sobre tamanho de k-mer baixo.
--mash_max_p	number	1.0	Valor máximo de p-valor a reportar.
--mash_max_dist	number	1.0	Distância máxima a reportar.
--merlin_dist	number	0.1	Distância máxima a reportar ao usar Merlin.
--full_merlin	boolean	false	Ativar o modo completo do Merlin e executar todas as ferramentas específicas de espécie, independentemente da distância Mash
--mash_use_fastqs	boolean	false	Consultar usando FASTQs em vez das montagens

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 incluir na análise
--exclude	string		Um arquivo de texto contendo nomes de amostras (um por linha) a excluir 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 gravar 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

Defina 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 sua 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 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 sua 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 os contêineres 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, force o fluxo de trabalho a baixar e converter contêineres Docker.
--force_rebuild	boolean	false	Forçar a substituição 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 passar para o executor. (ex.: SLURM: '--account=my_acct_name'
--container_opts	string		Opções adicionais a passar 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 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 (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 schema 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 usa os seguintes subworkflows:

• mashdist - Calcular distâncias Mash entre sequências e uma referência.

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)

• Mash
  Ondov BD, Treangen TJ, Melsted P, Mallonee AB, Bergman NH, Koren S, Phillippy AM Mash: fast genome and metagenome distance estimation using MinHash. Genome Biol 17, 132 (2016)

Fonte

Ver fonte no GitHub