跳转至

gget

当任务需要使用 gget CLI 或 Python 包在基因组参考数据库中进行快速生物信息学检索时,使用此技能。

何时使用

  • 检索 Ensembl ID、基因元数据、转录本详情或序列。
  • 在不构建完整本地流水线时执行快速 BLAST 或 BLAT 检索。
  • 从 Ensembl 获取参考基因组链接和注释。
  • 通过单一接口查询蛋白质结构、通路、癌症、表达或疾病相关模块。
  • 在迁移到 Biopython、Snakemake、Nextflow、BLAST+ 或数据库专用客户端等重量级工具之前,创建可复现的初步证据日志。

如果任务涉及受监管的临床解释、高吞吐量生产流水线,或需要精细控制数据库版本和本地索引,请使用专用工作流而不是 gget。

安装

使用干净的 Python 环境。

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

如果可用 uv:

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

在使用旧环境之前,请升级 gget 并重新确认模块文档。gget 查询的上游数据库会随时间变化。

基本模式

CLI 形式:

gget <module> [arguments] [options]

Python 形式:

import gget

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

常见工作流:

  1. 确定所需的物种、基因组组装、基因 ID 类型和数据库。
  2. 确认当前模块文档中关于参数的说明。
  3. 先执行小型查询。
  4. 使用明确的文件名和日期保存输出。
  5. 记录模块名、版本、参数和数据库前提条件。

主要模块

准确参数请使用当前上游文档。这些模块是常见的初始选择:

  • gget search: 从检索词查找 Ensembl ID。
  • gget info: 获取 Ensembl、UniProt 或相关 ID 的元数据。
  • gget seq: 获取核苷酸或氨基酸序列。
  • gget ref: 获取参考基因组下载链接。
  • gget blast: 执行快速 BLAST 查询。
  • gget blat: 将序列比对到受支持的基因组组装。
  • gget muscle: 执行多序列比对。
  • gget diamond: 对参考序列执行本地序列比对。
  • gget alphafold 和 gget pdb: 查看蛋白质结构参考。
  • gget enrichr、gget opentargets、gget archs4、gget bgee、gget cbio、gget cosmic: 探索富集、靶点、表达、癌症和疾病相关数据。

并非所有模块都支持所有 Python 版本或依赖集。某些可选科学依赖的版本支持范围可能比核心包更窄。

快速示例

检索基因:

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

获取基因元数据:

gget info ENSG00000012048 -o brca1-info.json

获取序列:

gget seq ENSG00000012048 -o brca1-seq.fa

执行小型 BLAST 查询:

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

Python 示例:

import gget

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

可复现性日志

对于科学输出,请包含足以复现查询的元数据。

| 日付 | gget バージョン | モジュール | クエリ | 種/アセンブリ | 出力 | 注記 |
| --- | --- | --- | --- | --- | --- | --- |
| 2026-05-11 | `gget --version` | search | `BRCA1 DNA repair` | human | `brca1-search.json` | 実行前にドキュメントを確認 |

还应记录:

  • Python 版本和环境管理器。
  • 通过 gget setup 安装的可选依赖。
  • 查询返回的数据库特定标识符。
  • 输出是 JSON、CSV、FASTA 还是 DataFrame 导出。
  • 通过升级 gget 解决的故障。

审查检查清单

  • 是否已升级或确认已安装的 gget 版本?
  • 是否在使用参数前确认了当前上游模块文档?
  • 物种或基因组组装是否明确?
  • 包含 Ensembl/UniProt 前缀的标识符是否准确保存?
  • 结果是否被标记为数据库输出而非临床解释?
  • 是否能从保存的命令或 Python 代码片段复现查询?
  • 可选依赖是否安装在隔离环境中?

参考文献

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 ev/ECC