GETVar 🧬👨🏻‍💻 [DO NOT USE THIS VERSION ⚠️]

THE UPDATED AND FUCTIONAL VERSION IS AVAILABLE ON: https://github.com/madsondeluna/getvar_mvp

O GETVar é uma ferramenta desenvolvida para análise e anotação de variantes genéticas. Com um workflow eficiente, a ferramenta integra dados de variantes genômicas para identificar e interpretar anotações de variantes de forma rápida e precisa em bancos de dados públicos.

Funcionalidades

• Análise de Variantes: Processamento e visualização dados de variantes genéticas.
• Anotação Funcional: Integração de variantes com consulta em bancos de dados genéticos.
• Automatização: Workflow padronizado para maior eficiência.

Workflow da Aplicação

1. Entrada de Dados:

   • Apenas arquivos VCF são válidos como entrada.

2. Identificação de Variantes:

   • A aplicação faz anotações com os seguintes campos:

     • ID: Identificador único da variante no banco de dados de referência.
     • CHROM: Cromossomo onde a variante está localizada.
     • REF: Alelo de referência no genoma.
     • ALT: Alelo alternativo identificado.
     • Population Allele Frequency: Frequência da variante em populações conhecidas.
     • Var Class: Classe da variante, como SNV (Single Nucleotide Variant) ou INDEL.
     • Most Severe Consequence: Consequência mais grave da variante em relação à função do gene.
     • Clinical Significance: Relevância clínica da variante com base em dados de referência.
     • Synonyms: Nomes alternativos ou identificadores da variante.
     • Ambiguity: Nível de ambiguïdade na identificação da variante.
     • Minor Allele: Alelo menos frequente encontrado na população.
     • Mappings: Informações adicionais de diferentes bancos e referências genômicas.

   • Os bancos consultados incluem dbSNP, Ensembl e ClinVar.

3. Anotação Funcional:

   • Integração com bancos de dados como dbSNP, ClinVar e Ensembl para fornecer informações funcionais e clínicas sobre as variantes.

Tecnologias Utilizadas

• Linguagem: Python
• Framework: Snakemake, Bootstrap e Flask
• Bancos de Dados: Integrações com dbSNP, ClinVar e Ensembl

Estrutura do Projeto

• main.py: Arquivo principal para executar a aplicação.
• api_getters.py: Contém funções para integrar e buscar dados externos.
• views.py: Gerencia as rotas e interações do usuário.
• utils.py: Arquivo com funções auxiliares para processamento de dados.
• Snakefile: Define os workflows automatizados usando Snakemake para gerenciar pipelines de análise.
• templates/: Arquivos HTML para visualização de resultados.
• static/: Arquivos de imagens e vídeos usados pela aplicação.
  • images/: Contém ícones, logos e outras imagens.
  • videos/: Contém vídeos ilustrativos ou de demonstração.
• requirements.txt: Lista de dependências necessárias para o projeto.
• .gitignore: Arquivo para ignorar arquivos e diretórios desnecessários no controle de versão.
• LICENSE: Arquivo contendo a licença do projeto.

Requisitos de Instalação

Certifique-se de ter as seguintes ferramentas instaladas:

• Python >= 3.8
• Gerenciador de pacotes pip

Instalação

1. Clone o repositório:

   git clone https://github.com/madsondeluna/getvar_containerized.git
   cd getvar_mvp

2. Crie um ambiente virtual (opcional, mas é recomendado):

   python3 -m venv venv
   source venv/bin/activate

3. Instale o Snakemake:

   pip install snakemake

Execução

1. Execute o snakemake:

  snakemake --unlock
  snakemake 

2. Acesse a aplicação no navegador em:

  http://localhost:5000

Exemplo de Uso

Submeta um arquivo VCF através da interface web. O sistema processará os dados, realizará as anotações e disponibilizará um relatório final em formato tabular que pode ser filtrada através das respectivas anotações.

Informaçõs Adicionais de Uso

As APIs REST do dbSNP, ClinVar e Ensembl possuem um limite de até 30 requisições por solicitação. Por isso, a aplicação pode apresentar instabilidade ou lentidão em alguns momentos. Além disso, os servidores dessas plataformas ocasionalmente podem ficar instáveis ou não responder adequadamente às requisições. Nesses casos, o manual das APIs recomenda a resubmissão dos dados para completar o processo de anotação.

Docker

Instalação e Uso

Para construir e executar a aplicação usando Docker, siga os passos abaixo:

1. Certifique-se de ter o Docker instalado em sua máquina. Você pode baixar e instalar o Docker a partir do site oficial.

2. Clone o repositório:

   git clone https://github.com/madsondeluna/getvar_containerized.git
   cd getvar_mvp

3. Construa a imagem Docker:

   docker build -t getvar_containerized .

4. Execute o contêiner Docker:

   docker run -p 5000:5000 getvar_containerized

5. Acesse a aplicação no navegador em:

   http://localhost:5000
   

Como Colaborar

Se você deseja colaborar com este projeto, siga os passos abaixo:

1. Faça um fork do repositório.

2. Crie uma nova branch para a sua feature ou correção de bug:

   git checkout -b minha-feature

3. Faça as alterações necessárias e commit:

   git commit -m "Adiciona minha feature"

4. Envie as alterações para o seu repositório forkado:

   git push origin minha-feature

5. Abra um Pull Request no repositório original.

Licença

Este projeto está licenciado sob a Licença MIT. Consulte o arquivo LICENSE para mais informações.

Contato

Madson Aragão
madsondeluna@gmail.com
LinkedIn

🌟 Created by Madson Aragão in somewhere, where bytes and biomolecules collide.