eggnog

Tags: functional-annotation orthology proteins eggnog bactopia-tool

Anotação funcional de proteínas usando grupos ortólogos e filogenias.

Esta Bactopia Tool usa o eggNOG-mapper para atribuir anotação funcional a sequências de proteínas. O eggNOG-mapper utiliza grupos ortólogos e filogenias do banco de dados eggNOG para realizar anotações funcionais mais precisas do que os métodos tradicionais baseados em homologia.

Uso

Bactopia CLI:

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

Nextflow:

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

Saídas

Arquivos de Saída Esperados

<BACTOPIA_DIR>
├── <SAMPLE_NAME>
│   └── tools
│       └── eggnog-<TIMESTAMP>
│           ├── <SAMPLE_NAME>.emapper.annotations
│           ├── <SAMPLE_NAME>.emapper.hits
│           ├── <SAMPLE_NAME>.emapper.seed_orthologs
│           └── logs
│               ├── nf.command.{begin,err,log,out,run,sh,trace}
│               └── versions.yml
└── bactopia-runs
    └── eggnog-<TIMESTAMP>
        └── nf-reports
            ├── eggnog-dag.dot
            ├── eggnog-report.html
            └── eggnog-timeline.html

Anotação

Arquivo	Descrição
*.emapper.annotations	Resultados da fase de anotação
*.emapper.hits	Resultados da fase de busca (HMMER, Diamond ou MMseqs2)
*.emapper.seed_orthologs	Resultados da análise dos hits
*.emapper.annotations.xlsx	Anotações em formato Excel
*.emapper.orthologs	Lista de ortólogos encontrados para cada consulta
*.emapper.genepred.fasta	Sequências de CDS preditas
*.emapper.gff	GFF das CDS preditas
*.emapper.no_annotations.fasta	Sequências sem anotação
*.emapper.pfam	Posições dos domínios PFAM identificados

Trilha de Auditoria

Abaixo estão os arquivos que podem ajudar 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	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 excelente resumo da sua execução. Podem ser usados para otimizar o uso de recursos e estimar custos esperados ao utilizar plataformas em nuvem.

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

Parâmetro	Tipo	Padrão	Descrição
--eggnog_db	string		Tarball ou caminho para os bancos de dados eggNOG
--download_eggnog	boolean	false	Necessário para baixar o banco de dados eggNOG mais recente; irá sobrescrever os bancos de dados existentes.
--eggnog_save_as_tarball	string		Salva o banco de dados eggNOG como um único tarball
--eggnog_skip_diamond	boolean	false	Não instala o banco de dados diamond
--eggnog_install_mmseq	boolean	false	Instala o banco de dados MMseqs2
--eggnog_install_pfam	boolean	false	Instala o banco de dados Pfam, necessário para anotação de novo ou realinhamento
--eggnog_install_hmm	boolean	false	Instala o banco de dados HMMER especificado com --hmmer_taxid
--eggnog_hmmer_taxid	integer	2	ID taxonômico do banco de dados HMM do eggNOG a ser baixado

Parâmetros do eggNOG Mapper

Parâmetro	Tipo	Padrão	Descrição
--eggnog_genepred	string	search	Método a ser usado para predição de genes (opções: search, prodigal)
--eggnog_mode	string	diamond	Método para busca nas sequências eggNOG (opções: diamond, hmmer, mmseqs, cache, no_search)
--eggnog_opts	string		Opções extras do eggNOG Mapper 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 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

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 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		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 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 as imagens Singularity, força o fluxo de trabalho a baixar e converter contêineres Docker.
--force_rebuild	boolean	false	Força a sobrescrita de ambientes pré-construídos existentes.
--queue	string	general,high-memory	Nome(s) separados por vírgula da(s) fila(s) a serem usadas 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	A quantidade de tempo (em segundos) que o Nextflow aguardará após configurar os datasets antes da execução.
--validate_params	boolean	true	Indica se os parâmetros devem ser validados contra o schema 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 da versão.

Composição

Este fluxo de trabalho utiliza os seguintes subworkflows:

• eggnog - Anotação funcional por atribuição de ortologia.

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)

• eggNOG-mapper
  Huerta-Cepas J, Forslund K, Coelho LP, Szklarczyk D, Jensen LJ, von Mering C, Bork P Fast Genome-Wide Functional Annotation through Orthology Assignment by eggNOG-Mapper. Mol. Biol. Evol. 34, 2115-2122 (2017)

• eggNOG 5.0 Database
  Huerta-Cepas J, Szklarczyk D, Heller D, Hernández-Plaza A, Forslund SK, Cook H, Mende DR, Letunic I, Rattei T, Jensen LJ, von Mering C, Bork P eggNOG 5.0: a hierarchical, functionally and phylogenetically annotated orthology resource based on 5090 organisms and 2502 viruses. Nucleic Acids Res. 47, D309-D314 (2019)

Fonte

Ver fonte no GitHub