reactome-database

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Reactome Analysis & Content Service

Reactome分析与内容服务

Prerequisites

前提条件

  1. uv
    : Read the
    uv
    skill and follow its Setup instructions to ensure
    uv
    is installed and on PATH.
  2. User Notification: If LICENSE_NOTIFICATION.txt does not already exist in this skill directory then (1) prominently notify the user to check the terms at https://reactome.org/license and https://reactome.org/cite, then (2) create the file recording the notification text and timestamp.
  1. uv
    :阅读
    uv
    技能文档并按照其设置说明操作,确保
    uv
    已安装且在PATH环境变量中。
  2. 用户通知:若此技能目录中不存在LICENSE_NOTIFICATION.txt文件,则(1)显著通知用户查看https://reactome.org/license和https://reactome.org/cite上的条款,然后(2)创建该文件并记录通知文本和时间戳。

Overview

概述

Reactome is a free, open-source, curated pathway database. This skill wraps both the Analysis Service (
https://reactome.org/AnalysisService/
) and the Content Service (
https://reactome.org/ContentService/
) providing pathway enrichment analysis, identifier mapping, reaction details, pathway hierarchy navigation, diagram export, cross-reference mapping, and search.
Reactome是一个免费、开源的 curated通路数据库。本技能封装了分析服务
https://reactome.org/AnalysisService/
)和内容服务
https://reactome.org/ContentService/
),可提供通路富集分析、标识符映射、反应详情、通路层级导航、通路图导出、交叉引用映射和搜索功能。

When to Use This Skill

何时使用该技能

  • Performing pathway enrichment (overrepresentation) analysis on gene/protein lists
  • Retrieving analysis results using a token from previous enrichment
  • Identifying which genes or proteins were not found in a pathway analysis
  • Analyzing gene expression data against pathway annotations
  • Mapping identifiers to Reactome entities across species
  • Retrieving reaction participants (inputs, outputs, catalysts, regulators)
  • Navigating pathway hierarchy and listing top-level pathways
  • Finding which complexes or sets contain a protein
  • Exporting pathway/reaction diagrams (PNG/SVG) with gene highlighting
  • Cross-referencing identifiers across databases (UniProt, Ensembl, etc.)
  • Searching the Reactome knowledgebase
  • Downloading analysis reports (PDF, CSV, JSON)
  • Comparing pathways across species
  • 对基因/蛋白质列表进行通路富集(过表达)分析
  • 使用之前富集分析得到的令牌检索分析结果
  • 识别通路分析中未找到的基因或蛋白质
  • 针对通路注释分析基因表达数据
  • 在不同物种间将标识符映射到Reactome实体
  • 获取反应参与者(输入、输出、催化剂、调控因子)
  • 导航通路层级并列出顶级通路
  • 查找包含某一蛋白质的复合物或集合
  • 导出带有基因高亮的通路/反应图(PNG/SVG格式)
  • 在不同数据库(UniProt、Ensembl等)间交叉引用标识符
  • 搜索Reactome知识库
  • 下载分析报告(PDF、CSV、JSON格式)
  • 跨物种比较通路

Common Species IDs

常见物种ID

Reference list for common research organisms:
  • Homo sapiens
    • ID: 9606
  • Mus musculus (Mouse)
    • ID: 48892
  • Rattus norvegicus (Rat)
    • ID: 48895
常用研究生物参考列表:
  • 智人(Homo sapiens)
    • ID: 9606
  • 小家鼠(Mus musculus,小鼠)
    • ID: 48892
  • 褐家鼠(Rattus norvegicus,大鼠)
    • ID: 48895

Common Pathway IDs

常用通路ID

Reference list for commonly used Reactome pathway stable IDs:
  • Cell Cycle
    • Stable ID: R-HSA-1640170
    • Notes: Top-level pathway (broad)
  • Cell Cycle, Mitotic
    • Stable ID: R-HSA-69278
    • Notes: Specific sub-pathway — use this for diagrams and drill-downs
  • Immune System
    • Stable ID: R-HSA-168256
    • Notes: Top-level pathway
  • Signal Transduction
    • Stable ID: R-HSA-162582
    • Notes: Top-level pathway
  • Gene Expression
    • Stable ID: R-HSA-74160
    • Notes: Top-level pathway
  • Programmed Cell Death
    • Stable ID: R-HSA-5357801
    • Notes: Top-level pathway
Important: When the user asks for a "Cell Cycle" diagram or analysis, prefer the specific Cell Cycle, Mitotic pathway (
R-HSA-69278
) unless the user explicitly requests the top-level overview. The examples throughout this document use
R-HSA-69278
.
常用Reactome通路稳定ID参考列表:
  • 细胞周期
    • 稳定ID: R-HSA-1640170
    • 说明:顶级通路(范围较广)
  • 细胞周期(有丝分裂)
    • 稳定ID: R-HSA-69278
    • 说明:特定子通路——用于通路图和深入分析
  • 免疫系统
    • 稳定ID: R-HSA-168256
    • 说明:顶级通路
  • 信号转导
    • 稳定ID: R-HSA-162582
    • 说明:顶级通路
  • 基因表达
    • 稳定ID: R-HSA-74160
    • 说明:顶级通路
  • 程序性细胞死亡
    • 稳定ID: R-HSA-5357801
    • 说明:顶级通路
重要提示:当用户请求“细胞周期”通路图或分析时,优先使用特定的**细胞周期(有丝分裂)**通路(
R-HSA-69278
),除非用户明确要求顶级概览。本文档中的示例均使用
R-HSA-69278

Core Rules

核心规则

  1. Always use
    --output
    : Every subcommand requires
    --output <file>
    to write results to a file. Never rely on stdout for large results.
  2. Default species is Homo sapiens: Use
    --species
    to override.
  3. Tokens expire after 7 days: Store tokens from analysis results to retrieve them later without re-submitting data.
  4. Use
    --fdr
    and
    --pvalue
    to filter
    : Enrichment results can be overwhelming. Filter with
    --fdr 0.05
    or
    --pvalue 0.01
    to focus on statistically significant pathways.
  5. Identifier formats: Reactome auto-detects identifiers including gene symbols (TP53), UniProt (P04637), Ensembl (ENSG00000141510), ChEBI, OMIM, EntrezGene, and many more.
  6. Handle large outputs: For commands that return large data (like
    species-comparison
    ), use the
    --summary
    flag to truncate lists and avoid exceeding workspace file size limits (1MB).
  7. Notification: If this skill is used, ensure this is mentioned in the output.
  1. 始终使用
    --output
    :每个子命令都需要
    --output <file>
    参数将结果写入文件。切勿依赖标准输出处理大量结果。
  2. 默认物种为智人:使用
    --species
    参数可覆盖默认设置。
  3. 令牌7天后过期:保存分析结果中的令牌,以便后续检索时无需重新提交数据。
  4. 使用
    --fdr
    --pvalue
    进行过滤
    :富集分析结果可能数量庞大。使用
    --fdr 0.05
    --pvalue 0.01
    过滤出具有统计学意义的通路。
  5. 标识符格式:Reactome可自动识别多种标识符,包括基因符号(TP53)、UniProt(P04637)、Ensembl(ENSG00000141510)、ChEBI、OMIM、EntrezGene等。
  6. 处理大输出:对于返回大量数据的命令(如
    species-comparison
    ),使用
    --summary
    标志截断列表,避免超过工作区文件大小限制(1MB)。
  7. 通知要求:若使用此技能,需确保在输出中提及这一点。

Tool Execution

工具执行

The CLI tool is at
scripts/reactome_analysis.py
. Run with
uv
:
bash
uv run scripts/reactome_analysis.py <command> [options] --output /tmp/out.json
To list all available subcommands and flags, run:
bash
uv run scripts/reactome_analysis.py --help
Use
--help
to verify available subcommands or flags before executing an unfamiliar command.
CLI工具位于
scripts/reactome_analysis.py
。使用
uv
运行:
bash
uv run scripts/reactome_analysis.py <command> [options] --output /tmp/out.json
查看所有可用子命令和标志,运行:
bash
uv run scripts/reactome_analysis.py --help
在执行不熟悉的命令前,使用
--help
验证可用的子命令或标志。

Feature Domains

功能领域

1. Database Info

1. 数据库信息

bash
uv run scripts/reactome_analysis.py db-version --output /tmp/version.json
uv run scripts/reactome_analysis.py db-name --output /tmp/name.json
bash
uv run scripts/reactome_analysis.py db-version --output /tmp/version.json
uv run scripts/reactome_analysis.py db-name --output /tmp/name.json

2. Single Identifier Analysis

2. 单个标识符分析

bash
uv run scripts/reactome_analysis.py identifier --id TP53 --output /tmp/tp53.json
uv run scripts/reactome_analysis.py identifier-projection --id TP53 --output /tmp/tp53_proj.json
bash
uv run scripts/reactome_analysis.py identifier --id TP53 --output /tmp/tp53.json
uv run scripts/reactome_analysis.py identifier-projection --id TP53 --output /tmp/tp53_proj.json

3. Batch Analysis (Enrichment)

3. 批量分析(富集)

Submit a list of identifiers for overrepresentation or expression analysis:
bash
uv run scripts/reactome_analysis.py analyze --data "TP53,BRCA1,EGFR" --output /tmp/enrich.json
uv run scripts/reactome_analysis.py analyze --file genes.txt --output /tmp/enrich.json
uv run scripts/reactome_analysis.py analyze-projection --data "TP53,BRCA1" --output /tmp/proj.json
uv run scripts/reactome_analysis.py analyze --data "TP53,BRCA1" --fdr 0.05 --output /tmp/sig.json
Common options:
--page-size
(alias
--limit
),
--page
(alias
--offset
),
--sort-by
,
--order
,
--resource
,
--species
,
--fdr
,
--pvalue
.
提交标识符列表进行过表达或表达分析:
bash
uv run scripts/reactome_analysis.py analyze --data "TP53,BRCA1,EGFR" --output /tmp/enrich.json
uv run scripts/reactome_analysis.py analyze --file genes.txt --output /tmp/enrich.json
uv run scripts/reactome_analysis.py analyze-projection --data "TP53,BRCA1" --output /tmp/proj.json
uv run scripts/reactome_analysis.py analyze --data "TP53,BRCA1" --fdr 0.05 --output /tmp/sig.json
常用选项:
--page-size
(别名
--limit
)、
--page
(别名
--offset
)、
--sort-by
--order
--resource
--species
--fdr
--pvalue

4. Token-Based Result Retrieval

4. 基于令牌的结果检索

bash
uv run scripts/reactome_analysis.py token-result --token TOKEN --output /tmp/result.json
uv run scripts/reactome_analysis.py token-not-found --token TOKEN --output /tmp/notfound.json
uv run scripts/reactome_analysis.py token-resources --token TOKEN --output /tmp/resources.json
uv run scripts/reactome_analysis.py token-found-entities --token TOKEN --pathway R-HSA-69278 --output /tmp/found.json
uv run scripts/reactome_analysis.py token-filter-species --token TOKEN --species-filter 9606 --output /tmp/filtered.json
uv run scripts/reactome_analysis.py token-reactions-pathway --token TOKEN --pathway R-HSA-69278 --output /tmp/rxns.json
bash
uv run scripts/reactome_analysis.py token-result --token TOKEN --output /tmp/result.json
uv run scripts/reactome_analysis.py token-not-found --token TOKEN --output /tmp/notfound.json
uv run scripts/reactome_analysis.py token-resources --token TOKEN --output /tmp/resources.json
uv run scripts/reactome_analysis.py token-found-entities --token TOKEN --pathway R-HSA-69278 --output /tmp/found.json
uv run scripts/reactome_analysis.py token-filter-species --token TOKEN --species-filter 9606 --output /tmp/filtered.json
uv run scripts/reactome_analysis.py token-reactions-pathway --token TOKEN --pathway R-HSA-69278 --output /tmp/rxns.json

5. Download Results

5. 下载结果

bash
uv run scripts/reactome_analysis.py download-result --token TOKEN --output /tmp/full.json
uv run scripts/reactome_analysis.py download-pathways --token TOKEN --output /tmp/pathways.csv
uv run scripts/reactome_analysis.py download-found --token TOKEN --output /tmp/found.csv
uv run scripts/reactome_analysis.py download-not-found --token TOKEN --output /tmp/notfound.csv
bash
uv run scripts/reactome_analysis.py download-result --token TOKEN --output /tmp/full.json
uv run scripts/reactome_analysis.py download-pathways --token TOKEN --output /tmp/pathways.csv
uv run scripts/reactome_analysis.py download-found --token TOKEN --output /tmp/found.csv
uv run scripts/reactome_analysis.py download-not-found --token TOKEN --output /tmp/notfound.csv

6. Identifier Mapping

6. 标识符映射

bash
uv run scripts/reactome_analysis.py mapping --data "TP53,BRCA1" --output /tmp/mapped.json
uv run scripts/reactome_analysis.py mapping-projection --data "TP53" --output /tmp/mapped_proj.json
bash
uv run scripts/reactome_analysis.py mapping --data "TP53,BRCA1" --output /tmp/mapped.json
uv run scripts/reactome_analysis.py mapping-projection --data "TP53" --output /tmp/mapped_proj.json

7. Reaction Participants & Mechanism of Action

7. 反应参与者与作用机制

Retrieve the molecular participants of a reaction (inputs, outputs, catalysts):
bash
uv run scripts/reactome_analysis.py participants --id R-HSA-6804194 --output /tmp/participants.json
uv run scripts/reactome_analysis.py participating-entities --id R-HSA-6804194 --output /tmp/entities.json
获取反应的分子参与者(输入、输出、催化剂):
bash
uv run scripts/reactome_analysis.py participants --id R-HSA-6804194 --output /tmp/participants.json
uv run scripts/reactome_analysis.py participating-entities --id R-HSA-6804194 --output /tmp/entities.json

8. Complex & Set Membership

8. 复合物与集合成员关系

Find which complexes or sets contain a given entity:
bash
uv run scripts/reactome_analysis.py component-of --id R-HSA-69488 --output /tmp/complexes.json
查找包含指定实体的复合物或集合:
bash
uv run scripts/reactome_analysis.py component-of --id R-HSA-69488 --output /tmp/complexes.json

9. Pathway Hierarchy Navigation

9. 通路层级导航

Move up (ancestors) or down (contained events) the pathway hierarchy:
bash
uv run scripts/reactome_analysis.py event-ancestors --id R-HSA-69278 --output /tmp/ancestors.json
uv run scripts/reactome_analysis.py contained-events --id R-HSA-69278 --output /tmp/steps.json
uv run scripts/reactome_analysis.py top-pathways --output /tmp/top.json
uv run scripts/reactome_analysis.py low-pathways --id R-HSA-69488 --output /tmp/low.json
在通路层级中向上(祖先)或向下(包含的事件)导航:
bash
uv run scripts/reactome_analysis.py event-ancestors --id R-HSA-69278 --output /tmp/ancestors.json
uv run scripts/reactome_analysis.py contained-events --id R-HSA-69278 --output /tmp/steps.json
uv run scripts/reactome_analysis.py top-pathways --output /tmp/top.json
uv run scripts/reactome_analysis.py low-pathways --id R-HSA-69488 --output /tmp/low.json

10. Diagram Export

10. 通路图导出

Export pathway or reaction diagrams as PNG/SVG, with optional gene highlighting:
bash
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --output /tmp/diagram.png
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --highlight TP53 --output /tmp/highlighted.png
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --format svg --output /tmp/diagram.svg
uv run scripts/reactome_analysis.py reaction-diagram --id R-HSA-6804194 --output /tmp/rxn.png
将通路或反应图导出为PNG/SVG格式,可选择高亮基因:
bash
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --output /tmp/diagram.png
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --highlight TP53 --output /tmp/highlighted.png
uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 --format svg --output /tmp/diagram.svg
uv run scripts/reactome_analysis.py reaction-diagram --id R-HSA-6804194 --output /tmp/rxn.png

11. Cross-Reference Mapping

11. 交叉引用映射

Resolve identifiers to Reactome internal IDs and cross-references:
bash
uv run scripts/reactome_analysis.py xref-mapping --id TP53 --output /tmp/xref.json
uv run scripts/reactome_analysis.py xref-mapping-batch --data "TP53,BRCA1" --output /tmp/xrefs.json
将标识符解析为Reactome内部ID和交叉引用:
bash
uv run scripts/reactome_analysis.py xref-mapping --id TP53 --output /tmp/xref.json
uv run scripts/reactome_analysis.py xref-mapping-batch --data "TP53,BRCA1" --output /tmp/xrefs.json

12. Search

12. 搜索

bash
uv run scripts/reactome_analysis.py search --query "TP53 apoptosis" --output /tmp/results.json
bash
uv run scripts/reactome_analysis.py search --query "TP53 apoptosis" --output /tmp/results.json

13. Query Entry by ID

13. 通过ID查询条目

bash
uv run scripts/reactome_analysis.py query --id R-HSA-69278 --output /tmp/entry.json
bash
uv run scripts/reactome_analysis.py query --id R-HSA-69278 --output /tmp/entry.json

14. Report & Species Comparison

14. 报告与物种比较

bash
uv run scripts/reactome_analysis.py report --token TOKEN --output /tmp/report.pdf
uv run scripts/reactome_analysis.py species-comparison --species-id 48892 --output /tmp/species.json
bash
uv run scripts/reactome_analysis.py report --token TOKEN --output /tmp/report.pdf
uv run scripts/reactome_analysis.py species-comparison --species-id 48892 --output /tmp/species.json

Use --summary to truncate large output and avoid workspace file size limits

使用--summary截断大输出,避免超过工作区文件大小限制

uv run scripts/reactome_analysis.py species-comparison --species-id 48892 --summary --output /tmp/species.json
undefined
uv run scripts/reactome_analysis.py species-comparison --species-id 48892 --summary --output /tmp/species.json
undefined

Recipe: Interpreting Gene Set Enrichment

方案:解读基因集富集分析

A step-by-step workflow for interpreting gene set enrichment results:
  1. Submit gene list with projection to human pathways:
    bash uv run scripts/reactome_analysis.py analyze-projection \ --data "TP53,BRCA1,EGFR,MYC,PTEN" --fdr 0.05 --output /tmp/enrichment.json
  2. Inspect top pathways — examine
    pathwaysFound
    , top pathway names, p-values, and FDR values in the output.
  3. Drill into a pathway — get its sub-events and reaction details:
    bash uv run scripts/reactome_analysis.py contained-events --id R-HSA-69278 --output /tmp/steps.json uv run scripts/reactome_analysis.py participants --id <reaction_id> --output /tmp/parts.json
  4. Visualise — export a diagram with your genes highlighted:
    bash uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 \ --highlight "TP53,BRCA1" --output /tmp/diagram.png
  5. Check hierarchy — navigate up to see broader biological context:
    bash uv run scripts/reactome_analysis.py event-ancestors --id R-HSA-69278 --output /tmp/ancestors.json
  6. Cross-reference — map identifiers to other databases:
    bash uv run scripts/reactome_analysis.py xref-mapping --id TP53 --output /tmp/xrefs.json
解读基因集富集分析结果的分步工作流:
  1. 提交基因列表并投影到人类通路:
    bash uv run scripts/reactome_analysis.py analyze-projection \ --data "TP53,BRCA1,EGFR,MYC,PTEN" --fdr 0.05 --output /tmp/enrichment.json
  2. 查看顶级通路——检查输出中的
    pathwaysFound
    、顶级通路名称、p值和FDR值。
  3. 深入分析某一通路——获取其子事件和反应详情:
    bash uv run scripts/reactome_analysis.py contained-events --id R-HSA-69278 --output /tmp/steps.json uv run scripts/reactome_analysis.py participants --id <reaction_id> --output /tmp/parts.json
  4. 可视化——导出带有基因高亮的通路图:
    bash uv run scripts/reactome_analysis.py diagram --id R-HSA-69278 \ --highlight "TP53,BRCA1" --output /tmp/diagram.png
  5. 检查层级——向上导航查看更广泛的生物学背景:
    bash uv run scripts/reactome_analysis.py event-ancestors --id R-HSA-69278 --output /tmp/ancestors.json
  6. 交叉引用——将标识符映射到其他数据库:
    bash uv run scripts/reactome_analysis.py xref-mapping --id TP53 --output /tmp/xrefs.json

Reference

参考资料

For detailed API endpoint documentation, see references/api_reference.md.
有关详细的API端点文档,请查看references/api_reference.md