jbrowse-plugin-protein3d

中文文档
1.28.1发布于 2026/11/04MITCommonJS构建来源已验证

A 3-D protein structure viewer for JBrowse 2, linked residue by residue to the genome.

原始使用文档
文档目录3 节
  1. Try it
  2. Documentation
  3. Publication

jbrowse-plugin-protein3d

A 3-D protein structure viewer for JBrowse 2, linked residue by residue to the genome.

TP53 beside PDB 1TUP, p53's core domain bound to DNA, with the R248 hotspot selected

TP53 beside PDB 1TUP, p53's core domain bound to DNA. R248, a cancer hotspot, is selected in magenta on the structure, and its codon is marked on the gene. Open this session. CI re-renders the figure from main every hour (scripts/readme-figure.mjs).

Right-click a gene and choose Open AlphaFold structure for its predicted model in one click, or Launch protein view for the dialog that offers every choice. The plugin looks up the AlphaFold model through UniProt, lists the experimental PDB entries SIFTS maps to that UniProt entry, and can search Foldseek for related structures. It aligns each structure to the transcript's translation, so hovering a residue highlights its codon and hovering a codon highlights its residue.

Try it

The protein browser takes a gene name and opens it in JBrowse with its structure linked to the genome. The plugin is also installed by default on genomes.jbrowse.org, so it works for any species there.

Documentation

Using the plugin:

  • Tutorials on jbrowse.org: TP53 from prediction to crystal opens an AlphaFold model and two crystal structures superposed beside the gene, and reads the R248 hotspot back to its codon; Proteins on genomes.jbrowse.org launches a structure and an MSA from any gene's right-click menu.
  • Demos: one link each. Genes opened by name alone in human, mouse, yeast, bacteria, fungi and viruses (E. coli recA, M. tuberculosis katG, the SARS-CoV-2 spike, the HIV-1 capsid), then the structures that are easy to map wrong — a peptide bound to a larger partner, a protein bound to DNA, a receptor with another protein fused into it, a phosphorylated residue, and a mitochondrial protein.
  • Your own structures: opening a model you folded yourself (ColabFold, AlphaFold 3, Boltz…) instead of the AlphaFold DB one, from a file, a URL or a generated link per gene, and which features carry over.

Linking and embedding:

  • Launching from a URL or code: worked session-spec links, the short uniprotId/pdbId + transcriptId form, several structures in one view, the 1D protein view, and the LaunchView-ProteinView and LaunchView-ProteinAnnotationView extension points.
  • Launch parameters: every argument, the connectedView settings, and the transcript feature shape.
  • Session snapshots: the saved view's shape, the structure shorthands, and which chain maps.

How it works, for someone extending the plugin or checking what a number on screen means:

  • Genome to structure alignment: why the plugin aligns the transcript's translation to the structure on the fly, the precedent for that in SIFTS and G2S, how it picks the chain and isoform, and what sequence alignment cannot decide.
  • UniProt feature tracks: where the accession and the UniProt-to-structure offset come from for AlphaFold models, PDB entries and your own models.
  • The secret sauce: one variable drawn with one scale in the 3D view, the alignment strip and the genome track, and the ideas that build on it, such as painting any genome track onto the structure.
  • Residue numbering: how a paper's R248 becomes position 154 in the file, label_seq_id 155 for Mol*, and the codon on chr17, and how a session spec names a residue the literature's way.

Working on the plugin:

  • DEVELOPERS.md: running it locally and publishing.
  • Testing: the unit, e2e, documentation and demo checks.
  • Host compatibility: which JBrowse hosts load the published bundle, and the gate that boots it on one.
  • Live checks: serving a local build to a session on jbrowse.org.

Publication

If you find this tool useful please cite our work

Diesh, C., Stevens, G., Bridge, C., Hogue, G., Buels, R., Cain, S., Stein, L., & Holmes, I. (2026). Proteins in the Genome Browser: Integration of Phylogenies, Alignments, and Structures With Nucleotide-level Evidence in JBrowse 2. Journal of Molecular Biology, 169645. https://doi.org/10.1016/j.jmb.2026.169645

See also https://github.com/GMOD/proteinbrowser for overview

版本与发布记录

jbrowse-plugin-protein3d 共发布 102 个版本,首次发布于 2024/07/08;过去 12 个月发布了 89 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.28.1latest2026/11/041 天前
1.28.02026/10/315 天前
1.27.02026/10/297 天前
1.26.12026/10/279 天前
1.26.02026/10/2214 天前
1.25.02026/10/2214 天前

关于 jbrowse-plugin-protein3d 的常见问题

jbrowse-plugin-protein3d 是什么?

A 3-D protein structure viewer for JBrowse 2, linked residue by residue to the genome.

如何安装 jbrowse-plugin-protein3d?

在项目目录运行 npm install jbrowse-plugin-protein3d,或使用 pnpm add / yarn add / bun add。

jbrowse-plugin-protein3d 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/jbrowse-plugin-protein3d 是否存在。

jbrowse-plugin-protein3d 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

jbrowse-plugin-protein3d 可以商用吗?

jbrowse-plugin-protein3d 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

jbrowse-plugin-protein3d 还在维护吗?

最新版本 1.28.1 发布于 2026/11/04(1 天前);至今共发布 102 个版本,其中过去 12 个月发布了 89 个;首次发布于 2024/07/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。