Documentação ViralQC

🌐 Language / Idioma

This documentation is also available in English: Click here

ViralQC é uma ferramenta e pacote Python desenvolvido para identificação de vírus e controle de qualidade a partir de arquivos FASTA.

A ferramenta utiliza o Nextclade, o BLAST e uma série de lógicas internas para classificar sequências virais e realizar controle de qualidade de genomas completos, regiões ou genes-alvo.

A ferramenta foi desenvolvida com o objetivo de automatizar o uso das ferramentas Nextclade e BLAST pensando na integração com bancos de dados genômicos de diferentes vírus, de modo a diminuir erros de submissão (como por exemplo, submissão de genomas com informação taxonômica incorreta) e também providenciar para o usuário métricas de qualidade de genomas virais mesclando as métricas do Nextclade disponibilizadas por datasets padronizados mas também providenciar métricas generalistas e anotações com base nos genomas de referência (refseq) disponibilizados pelo NCBI.

Principais Funcionalidades

• Identificação automática de vírus usando Nextclade e BLAST

• Controle de qualidade de genomas virais usando Nextclade

• Extração de regiões-alvo (CDS ou genes específicos)

• Análise de múltiplos vírus em um único arquivo FASTA

• Configuração flexível através do arquivo datasets.yml

Conteúdo da Documentação

• Instalação
  • Pré-requisitos
  • Instalação via pip
  • Instalação a partir do código-fonte
• Configuração de Datasets
  • Estrutura do arquivo datasets.yml
  • Datasets do Nextclade
  • Datasets do GitHub
  • Parâmetros de Configuração
• Lógica de Pontuação
  • Por Que Um Sistema Próprio?
  • Métricas de Qualidade
  • Cálculo do genomeQuality
  • Extração de Regiões-Alvo
• Comandos e Uso
  • get-nextclade-datasets
  • get-blast-database
  • run
  • API
• Como Adicionar Novos Datasets
  • Adicionando Dataset do Nextclade
  • Adicionando Dataset do GitHub
• Estrutura de Saída
  • Arquivo Principal: results.tsv (ou .csv, .json)
  • Arquivos de Regiões-Alvo
  • Arquivos de Anotação
• Exemplos Práticos
  • Exemplo 1: Análise Básica de Dengue
  • Exemplo 2: Influenza (Múltiplos Segmentos)
  • Exemplo 3: Análise Metagenômica
  • Exemplo 4: Banco de Dados Reproduzível
  • Exemplo 5: Saída em JSON
  • Exemplo 6: Busca BLAST Sensível
• Solução de Problemas
  • Problema 1: Comando vqc não encontrado
  • Problema 2: Erro ao baixar datasets
  • Problema 3: Banco BLAST não encontrado
  • Problema 4: Nenhuma sequência mapeada
  • Problema 5: Erros de memória
  • Problema 6: Permissão negada
  • Problema 7: Datasets do GitHub não baixados
  • Obtendo Ajuda
• Guia do Desenvolvedor
  • Gerenciamento de datasets (Datasets)
  • Pipeline de Análise

Links Rápidos

• Repositório GitHub

• Issues/Bugs

• Licença: MIT

Referências

Ao utilizar o viralQC para fins acadêmicos, cite também:

• Nextclade: Aksamentov, I., Roemer, C., Hodcroft, E. B., & Neher, R. A., (2021). Nextclade: clade assignment, mutation calling and quality control for viral genomes. JOSS, 6(67), 3773.

• BLAST: Altschul SF, et al. (1990). Basic local alignment search tool. J Mol Biol. 215(3):403-10.