staphtyper

Tags: staphylococcus-aureus agr spa sccmec surveillance typing bactopia-tool

Tipagem abrangente de genomas de Staphylococcus aureus.

Esta Bactopia Tool é um subworkflow que inclui múltiplas ferramentas específicas para tipagem de características de Staphylococcus aureus. Atualmente, o staphtyper inclui:

1. AgrVATE - tipo de locus agr e variantes do operon
2. spaTyper - tipo spa
3. sccmec - tipo SCCmec
4. StaphSCAN - vigilância baseada em genoma

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       ├── agrvate
│       │   ├── <SAMPLE_NAME>.tsv
│       │   ├── logs
│       │   │   ├── nf.command.{begin,err,log,out,run,sh,trace}
│       │   │   └── versions.yml
│       │   └── supplemental
│       │       ├── <SAMPLE_NAME>-agr_gp.tab
│       │       ├── <SAMPLE_NAME>-blastn_log.txt
│       │       └── <SAMPLE_NAME>.fna-error-report.tab
│       ├── sccmec
│       │   ├── <SAMPLE_NAME>.regions.blastn.tsv
│       │   ├── <SAMPLE_NAME>.regions.details.tsv
│       │   ├── <SAMPLE_NAME>.targets.blastn.tsv
│       │   ├── <SAMPLE_NAME>.targets.details.tsv
│       │   ├── <SAMPLE_NAME>.tsv
│       │   └── logs
│       │       ├── nf.command.{begin,err,log,out,run,sh,trace}
│       │       └── versions.yml
│       ├── spatyper
│       │   ├── <SAMPLE_NAME>.tsv
│       │   └── logs
│       │       ├── nf.command.{begin,err,log,out,run,sh,trace}
│       │       └── versions.yml
│       └── staphscan
│           ├── <SAMPLE_NAME>.tsv
│           └── logs
│               ├── nf.command.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
└── bactopia-runs
    └── staphtyper-<TIMESTAMP>
        ├── merged-results
        │   ├── agrvate.tsv
        │   ├── logs
        │   │   ├── agrvate-concat
        │   │   │   ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │   │   └── versions.yml
        │   │   ├── sccmec-concat
        │   │   │   ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │   │   └── versions.yml
        │   │   ├── spatyper-concat
        │   │   │   ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │   │   └── versions.yml
        │   │   └── staphscan-concat
        │   │       ├── nf.command.{begin,err,log,out,run,sh,trace}
        │   │       └── versions.yml
        │   ├── sccmec.tsv
        │   ├── spatyper.tsv
        │   └── staphscan.tsv
        └── nf-reports
            ├── staphtyper-dag.dot
            ├── staphtyper-report.html
            └── staphtyper-timeline.html

Tipagem Abrangente

Nota

Resultados de todas as ferramentas de tipagem incluídas

Arquivo	Descrição
staphtyper.tsv	Resumo consolidado contendo os resultados de tipagem agr, spa e SCCmec

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. Nessa pasta há arquivos úteis para 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/desfazer 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.

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

Parâmetros do AgrVATE

Parâmetro	Tipo	Padrão	Descrição
--agrvate_typing_only	boolean	false	Somente tipagem agr. Pula a extração do operon agr e a detecção de frameshift

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 spaTyper

Parâmetro	Tipo	Padrão	Descrição
--spatyper_repeats	string		Lista de repetições spa
--spatyper_repeat_order	string		Lista de tipos spa e ordem das repetições
--spatyper_do_enrich	boolean	false	Realizar enriquecimento do produto de PCR

Parâmetros do sccmec

Parâmetro	Tipo	Padrão	Descrição
--sccmec_min_targets_pident	integer	90	Percentual mínimo de identidade para contabilizar um hit de alvo
--sccmec_min_targets_coverage	integer	80	Percentual mínimo de cobertura para contabilizar um hit de alvo
--sccmec_min_regions_pident	integer	85	Percentual mínimo de identidade para contabilizar um hit de região
--sccmec_min_regions_coverage	integer	93	Percentual mínimo de cobertura para contabilizar um hit de região

Parâmetros do StaphSCAN

Parâmetro	Tipo	Padrão	Descrição
--staphscan_modules	string		Lista de módulos a executar separados por vírgula
--staphscan_db_mlst	string		Caminho ou tarball para banco de dados MLST personalizado

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

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 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 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 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 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 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 os 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 diretamente as imagens Singularity, 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) das filas 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	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 texto de ajuda.
--wf	string	bactopia	Especifica qual fluxo de trabalho ou Bactopia Tool executar
--list_wfs	boolean		Listar os fluxos de trabalho e Bactopia Tools disponíveis para usar 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 da versão.

Composição

Este fluxo de trabalho usa os seguintes subworkflows:

• staphtyper - Determina os tipos agr, spa e SCCmec e realiza vigilância baseada em genoma para genomas de Staphylococcus aureus.

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)

• AgrVATE
  Raghuram V. AgrVATE: Rapid identification of Staphylococcus aureus agr locus type and agr operon variants. (GitHub)

• sccmec
  Petit III RA, Read TD sccmec: A tool for typing SCCmec cassettes in assemblies (GitHub)

• spaTyper
  Sanchez-Herrero JF, and Sullivan M spaTyper: Staphylococcal protein A (spa) characterization pipeline. Zenodo. (2020)

• StaphSCAN
  Bollini R StaphSCAN (v0.3.0). Zenodo (2026)

Fonte

Ver fonte no GitHub