ectyper

Tags: escherichia-coli serotyping fasta bactopia-tool

Predição in silico do sorotipo de Escherichia coli.

Esta Bactopia Tool utiliza o ECTyper para realizar a predição in silico do sorotipo de genomas de Escherichia coli. Ela usa as montagens do genoma para fornecer identificação básica de espécie e o sorotipo previsto de E. coli (por exemplo, O174:H21).

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

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

Resultados por Amostra

Arquivo	Descrição
*.tsv	Arquivo delimitado por tabulação com o resultado do ECTyper
blast_output_alleles.txt	Relatório de alelos gerado a partir dos resultados do BLAST

Resultados Consolidados

Arquivo	Descrição
ectyper.tsv	Arquivo TSV consolidado contendo os resultados do ECTyper 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. Nessa pasta estão arquivos úteis para consulta 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 ótimo resumo da sua execução. Podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas de nuvem.

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

Parâmetro	Tipo	Padrão	Descrição
--ectyper_opid	integer	90	Percentual de identidade necessário para correspondência de alelo do antígeno O
--ectyper_opcov	integer	90	Percentual mínimo de cobertura necessário para correspondência de alelo do antígeno O
--ectyper_hpid	integer	95	Percentual de identidade necessário para correspondência de alelo do antígeno H
--ectyper_hpcov	integer	50	Percentual mínimo de cobertura necessário para correspondência de alelo do antígeno H
--ectyper_verify	boolean	false	Habilita a verificação de espécie de E. coli
--ectyper_print_alleles	boolean	false	Imprime as sequências dos alelos como coluna final, se habilitado

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

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 os ambientes Conda
--registry	string	quay.io	Registro para 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 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 para passar ao executor. (ex.: SLURM: '--account=my_acct_name'
--container_opts	string		Opções adicionais para passar 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		Imprime 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 Bactopia Tool executar
--list_wfs	boolean		Lista os fluxos de trabalho e Bactopia Tools 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 de versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• ectyper - Predição in silico do sorotipo de Escherichia coli.

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)

• ECTyper
  Laing C, Bessonov K, Sung S, La Rose C ECTyper - In silico prediction of Escherichia coli serotype (GitHub)

Fonte

Ver fonte no GitHub