prokka

Tags: annotation genome prokaryote functional-annotation genes bactopia-tool

Anotação rápida de genomas completos de bactérias, arqueias e vírus.

Esta Bactopia Tool usa o Prokka para anotar rapidamente genomas pequenos de forma padronizada. Ele identifica genes codificadores de proteínas, rRNA, tRNA e outras features, e então realiza buscas em múltiplos bancos de dados de referência para fornecer uma anotação funcional abrangente.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── main
│       └── annotator
│           └── prokka-<TIMESTAMP>
│               ├── <SAMPLE_NAME>-blastdb.tar.gz
│               ├── <SAMPLE_NAME>.faa.gz
│               ├── <SAMPLE_NAME>.ffn.gz
│               ├── <SAMPLE_NAME>.fna.gz
│               ├── <SAMPLE_NAME>.fsa.gz
│               ├── <SAMPLE_NAME>.gbk.gz
│               ├── <SAMPLE_NAME>.gff.gz
│               ├── <SAMPLE_NAME>.sqn.gz
│               ├── <SAMPLE_NAME>.tbl.gz
│               ├── <SAMPLE_NAME>.tsv
│               ├── <SAMPLE_NAME>.txt
│               └── logs
│                   ├── <SAMPLE_NAME>.err
│                   ├── <SAMPLE_NAME>.log
│                   ├── nf.command.{begin,err,log,out,run,sh,trace}
│                   └── versions.yml
└── bactopia-runs
    └── prokka-<TIMESTAMP>
        └── nf-reports
            ├── prokka-dag.dot
            ├── prokka-report.html
            └── prokka-timeline.html

Resultados por Amostra

Arquivo	Descrição
*.gff	Anotação do genoma no formato GFF3 contendo sequências e anotações
*.gbk	Anotação do genoma no formato GenBank contendo sequências e anotações
*.faa	Arquivo FASTA de proteínas das sequências CDS traduzidas
*.fna	Arquivo FASTA de nucleotídeos das sequências de contigs de entrada
*.ffn	Arquivo FASTA de nucleotídeos de todos os transcritos preditos
*.fsa	Arquivo FASTA de nucleotídeos das sequências proteicas preditas
*.sqn	Arquivo Sequin no formato ASN1 para submissão ao GenBank
*.tbl	Arquivo de Tabela de Features para submissão ao GenBank
*.tsv	Arquivo separado por tabulações com todas as features e informações funcionais
*.txt	Relatório estatístico das features anotadas
*.blastdb.tar.gz	Arquivo de banco de dados BLAST+ de contigs, genes e proteínas

Resultados Consolidados

Arquivo	Descrição
prokka.tsv	Arquivo TSV consolidado contendo resumos de anotação 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 revisão 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 ótimo resumo da sua execução. Eles podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas de nuvem.

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

Parâmetro	Tipo	Padrão	Descrição
--prokka_proteins	string		Arquivo FASTA de proteínas confiáveis para anotar primeiro
--prokka_prodigal_tf	string		Arquivo de treinamento a ser usado para o Prodigal
--prokka_compliant	boolean	false	Forçar conformidade com Genbank/ENA/DDJB
--prokka_centre	string	Bactopia	ID do centro de sequenciamento
--prokka_coverage	integer	80	Cobertura mínima na proteína de consulta
--prokka_evalue	string	1e-09	Corte de e-value para similaridade
--prokka_opts	string		Opções extras do Prokka entre aspas.
--prokka_debug	boolean	false	Ativar modo de depuração para o Prokka

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

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 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á deletado.

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		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 os contêineres Docker serão baixados.
--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çar o fluxo de trabalho a baixar e converter contêineres Docker.
--force_rebuild	boolean	false	Forçar sobrescrita de ambientes pré-construídos existentes.
--queue	string	general,high-memory	Nome(s) separado(s) por vírgula da(s) fila(s) a ser(em) usada(s) 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		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 que indica se os parâmetros devem ser validados 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 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 de versão.

Composição

Este fluxo de trabalho usa os seguintes subworkflows:

• prokka - Anotar genomas bacterianos com informações funcionais.

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)

• Prokka
  Seemann T Prokka: rapid prokaryotic genome annotation Bioinformatics 30, 2068-2069 (2014)

Fonte

Ver fonte no GitHub