seqsero2

Tags: salmonella serotyping epidemiology o-antigen h-antigen bactopia-tool

Predição de sorotipo de Salmonella a partir de reads de sequenciamento ou montagens.

Esta Ferramenta Bactopia utiliza o SeqSero2 para prever sorotipos de Salmonella tanto a partir de reads brutos de sequenciamento quanto de genomas montados. SeqSero2 é um pipeline inovador para determinar sorotipos de Salmonella usando reads brutos de sequenciamento ou montagens, por meio de análise de k-mer e identificação direcionada dos genes dos antígenos O e H. A ferramenta fornece predições precisas de sorotipo seguindo o esquema Kaufmann-White, suportando métodos de sorotipagem tradicionais e moleculares para vigilância epidemiológica e investigação de surtos.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

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

Resultados por Amostra

Arquivo	Descrição
*_result.tsv	Arquivo delimitado por tabulação com resultados detalhados do SeqSero2 para cada amostra
*_result.txt	Arquivo de texto com pares chave-valor dos resultados de predição do SeqSero2
*_log.txt	Arquivo de log detalhado da análise do SeqSero2

Resultados Consolidados

Arquivo	Descrição
seqsero2.tsv	Arquivo TSV consolidado contendo os resultados do SeqSero2 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 há arquivos úteis para você revisar caso seja 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 no formato YAML com as versões dos programas

Relatórios do Nextflow

Esses 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 em nuvem.

Arquivo	Descrição
seqsero2-dag.dot	A visualização DAG do Nextflow
seqsero2-report.html	O Relatório de Execução do Nextflow
seqsero2-timeline.html	O Relatório de Linha do Tempo do Nextflow
seqsero2-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 do SeqSero2

Parâmetro	Tipo	Padrão	Descrição
--seqsero2_run_mode	string	k	Fluxo de trabalho a executar. Modo alelo 'a' ou modo k-mer 'k' (opções: a, k)
--seqsero2_input_type	string	assembly	Formato de entrada a analisar. 'assembly' ou 'fastq' (opções: assembly, fastq)
--seqsero2_bwa_mode	string	mem	Algoritmos para mapeamento bwa no modo alelo (opções: mem, sam)

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

Define o limite máximo de recursos solicitados para qualquer trabalho 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 trabalho individual.
--max_memory	string	128.GB	Quantidade máxima de memória que pode ser solicitada para qualquer trabalho individual.
--max_time	string	240.h	Tempo máximo que pode ser solicitado para qualquer trabalho individual.
--max_downloads	integer	3	Número máximo de amostras a 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 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 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 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 para uso com Singularity, força o fluxo de trabalho a baixar e converter contêineres Docker.
--force_rebuild	boolean	false	Força a substituição de ambientes pré-construídos existentes.
--queue	string	general,high-memory	Nome(s) das filas separados por vírgula a serem usadas por um agendador de tarefas (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 pouco utilizados 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 onde o Nextflow baixou o Bactopia
--sleep_time	integer	5	O tempo (em segundos) que o Nextflow aguardará após configurar os datasets antes de iniciar a execução.
--validate_params	boolean	true	Booleano que indica 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:

• seqsero2 - Prever sorotipos de Salmonella a partir de montagens de genomas.

Citações

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

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

• SeqSero2
  Zhang S, Den-Bakker HC, Li S, Dinsmore BA, Lane C, Lauer AC, Fields PI, Deng X. SeqSero2: rapid and improved Salmonella serotype determination using whole genome sequencing data. Appl Environ Microbiology 85(23):e01746-19 (2019)

Fonte

Ver fonte no GitHub