gget

Use esta ferramenta quando uma tarefa precisar de consultas rápidas de bioinformática em bancos de dados de referência genômica com a CLI gget ou pacote Python.

Quando Usar

• Encontrar IDs do Ensembl, metadados de genes, detalhes de transcritos ou sequências.
• Executar consultas rápidas de BLAST ou BLAT sem construir um pipeline local completo.
• Obter links de genomas de referência e anotações do Ensembl.
• Consultar módulos de estrutura de proteínas, vias metabólicas, câncer, expressão ou associação a doenças através de uma única interface.
• Criar um registro de evidências inicial e reproduzível antes de passar para ferramentas mais robustas como Biopython, Snakemake, Nextflow, BLAST+ ou clientes específicos de banco de dados.

Use um fluxo de trabalho dedicado em vez de gget quando a tarefa exigir interpretação clínica regulamentada, pipelines de produção de alto rendimento ou controle granular sobre versões de banco de dados e índices locais.

Instalação

Use um ambiente Python limpo.

python -m venv .venv
. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install --upgrade gget
gget --help

Se uv estiver disponível:

uv venv
. .venv/bin/activate
uv pip install gget

Antes de confiar em um ambiente mais antigo, atualize gget e verifique a documentação do módulo novamente. Os bancos de dados upstream consultados por gget mudam com o tempo.

Padrões Básicos

Formato da CLI:

gget <module> [arguments] [options]

Formato Python:

import gget

result = gget.search(["BRCA1"], species="human")
print(result)

Fluxo de trabalho comum:

1. Identifique a espécie, montagem, tipo de ID do gene e banco de dados necessários.
2. Verifique a documentação atual do módulo para os argumentos.
3. Execute uma consulta pequena primeiro.
4. Salve a saída com um nome de arquivo explícito e data.
5. Registre o nome do módulo, versão, argumentos e suposições do banco de dados.

Módulos Comuns

Use a documentação upstream atual para argumentos exatos. Estes módulos são escolhas iniciais comuns:

• gget search: encontrar IDs do Ensembl a partir de termos de busca.
• gget info: recuperar metadados para IDs do Ensembl, UniProt ou relacionados.
• gget seq: obter sequências de nucleotídeos ou aminoácidos.
• gget ref: recuperar links de download de genomas de referência.
• gget blast: executar uma consulta BLAST rápida.
• gget blat: localizar uma sequência contra montagens de genoma suportadas.
• gget muscle: executar alinhamento de múltiplas sequências.
• gget diamond: executar alinhamento de sequência local contra sequências de referência.
• gget alphafold e gget pdb: inspecionar referências de estrutura de proteínas.
• gget enrichr, gget opentargets, gget archs4, gget bgee, gget cbio e gget cosmic: explorar dados de enriquecimento, alvos, expressão, câncer e associação a doenças.

Não assuma que todos os módulos suportam todas as versões do Python ou conjuntos de dependências. Algumas dependências científicas opcionais têm suporte de versão mais restrito do que o pacote principal.

Exemplos Rápidos

Encontrar genes:

gget search -s human brca1 dna repair -o brca1-search.json

Obter metadados de genes:

gget info ENSG00000012048 -o brca1-info.json

Obter uma sequência:

gget seq ENSG00000012048 -o brca1-seq.fa

Executar uma consulta BLAST pequena:

gget blast "MEEPQSDPSVEPPLSQETFSDLWKLLPEN" -l 10 -o blast-results.json

Exemplo Python:

import gget

genes = gget.search(["BRCA1", "DNA repair"], species="human")
info = gget.info(["ENSG00000012048"])
sequence = gget.seq("ENSG00000012048")

Registro de Reprodutibilidade

Para saídas científicas, inclua metadados suficientes para reproduzir a consulta.

| Date | gget version | Module | Query | Species/assembly | Output | Notes |
| --- | --- | --- | --- | --- | --- | --- |
| 2026-05-11 | `gget --version` | search | `BRCA1 DNA repair` | human | `brca1-search.json` | Docs checked before run |

Também registre:

• Versão do Python e gerenciador de ambiente.
• Qualquer dependência opcional instalada através de gget setup.
• Identificadores específicos do banco de dados retornados pela consulta.
• Se a saída é JSON, CSV, FASTA ou uma exportação de DataFrame.
• Quaisquer falhas que foram resolvidas atualizando gget.

Lista de Verificação de Revisão

• Você atualizou ou verificou a versão instalada de gget?
• Você verificou a documentação atual do módulo upstream antes de usar os argumentos?
• A espécie ou montagem está explícita?
• Os identificadores são preservados exatamente, incluindo prefixos Ensembl/UniProt?
• O resultado é rotulado como saída de banco de dados em vez de interpretação clínica?
• A consulta é reproduzível a partir do comando salvo ou trecho Python?
• As dependências opcionais estão instaladas em um ambiente isolado?

Referências

…