@galaxyproject/varri

中文文档
0.0.0发布于 2026/09/16MITES Module零依赖近 30 天下载 7969

VARRI的银河可视化 - RNA-RNA相互作用的可视化注释

中文使用文档
文档目录8 节
  1. 如何运作
  2. 为什么上游景点是批发的
  3. 构建
  4. 数据集格式
  5. 如何嵌入上游编辑器 UI
  6. 本地测试
  7. 安装到银河系统实例(用于开发)
  8. 许可证

@galaxyproject/ varri (英语)

银河可视化插件 瓦里语 —— 说 rNA-RNA相互作用的可视化注释.

该插件将生成一个 Galaxy 数据集( JSON 与 sequence 财务报告和审定财务报表 structure使用 varri-js 库:交互式缩放/页、区域/子序列/图解说明, 概率剖面图,以及 SVG/PNG 导出.

如何运作

这个套装也一样 银河图表 维特 本寄存器中其他软件包使用的常规(例如参见:. packages/aladin:

  • main.js - 银河胶:读取 data-incoming 属性,从 将销售商的上游取景器嵌入 <iframe> 与 作为 URL 查询字符串转发的数据集参数.
  • main.css ——最小布局/工具栏造型.
  • index.html ——Vite条目HTML页面.
  • vite.config.js 编号 : vite.config.charts.js 建筑配置; vite build 捆绑 main.js 输入 static/index.js 财务报告和审定财务报表 main.css 输入 static/index.css。 。 。 .
  • public/varri.xml —— Galaxy 插件描述符(entry_point 捆绑的分数 index.js编号 :index.css) (中文(简体) ).
  • public/logo.svg ——插件图标.

为什么上游景点是批发的

此插件不重执行任何部分 瓦里语 UI(设置面板,突出显示/mutation编辑器,SVG/PNG导出,帮助,引用页,.). 相反, main.js 将完整、未修改的上游取景器嵌入 <iframe>,以及 纯粹通过它已经支持共享/嵌入的 URL 参数驱动它(参见 "URL参数与共享"在其README. 这意味着没有按钮/标签重复和没有 依赖 vaRRI JS API 在这里维护——如果上游添加、重命名或去除 设置, 此插件不会改变; 只有 a varri-js 需要版本折叠 .

这个 vite-plugin-static-copy 插件( 配置于 vite.config.js复制整个 varri-js npm 软件包来自 node_modules/varri-js 输入 static/vendor/varri-js/ 在建设中 时间, 未经修改的 —— 与此 repo 所使用的方法相同 polaris 财务报告和审定财务报表 vintent 软件包到 供应商 pyodide。不同于习惯 predev编号 :prebuild 脚本, vite-plugin-static-copy (单位:千美元) 在 vite dev编号 :vite preview不仅仅是 vite build永远 从 GitHub 或任何其他外部来源下载任何信息—— 只有已经发布的文件 输入 varri-js npm 软件包.

构建

npm install     # installs varri-js (devDependency) among others
npm run build   # runs `vite build` into static/, vendoring the vaRRI viewer as it goes
npm run dev     # local development server (vendor assets served directly, not copied)
npm test        # sanity-checks the built static/ output

数据集格式

数据集必须是 json 银河数据集,包含一个平面对象: vaRRI URL 参数。 。 。 . 所有密钥都是可选的,但 sequence 财务报告和审定财务报表 structure数字 :

{
    "sequence": "AACUCGCGAAAGCCAUAAAAACCAGGGAGACA&UUCCCUGGUGUUGGCGCAGUAUUCGCGCA",
    "structure": "....((((((.((((.....((((((((....&.))))))))..))))......))))))..",
    "startIndex1": -35,
    "startIndex2": 2,
    "subsequenceHighlights": [{ "sequence": 1, "range": "-12--6", "color": "#0dec3f", "alpha": 0.9 }],
    "pointMutations": [{ "sequence": 1, "position": -14, "replacement": "G", "color": "#fb0bcb" }],
    "forceLayout": false
}

请注意: subsequenceHighlights, (中文(简体) ), regionHighlights,以及 pointMutations 是数组 与库本身的图案相匹配的结构化对象,而不是逗号分隔 由上游vaRRI编辑的GUI输入字段使用的迷你语言(见下文).

如何嵌入上游编辑器 UI

这个 varri-js npm 包船是一个完整的浏览器/编辑网页(index.html, (中文(简体) ), index.js, (中文(简体) ), style.css)——同页服务于 https://backofenlab.github.io/vaRRI/ (英语)此插件 已经 嵌入该页, 未修改,在 <iframe>: 整个编辑 UI( 设置面板、 注释) 控件,导出按钮,引用页,...)在 iframe 中可以使用,只是 像独立页。 唯一的微调是 hideFooterAndHeader 網址 参数,可以删除页眉和页脚,但保留控件 面板可见——完全如上游文件所示,所以用户仍然可以微调 参数和加载后重排。 银河系统提供数据集参数如下: 查询字符串和上游页面处理所有渲染,所以这个插件 包含没有重复的 UI 或渲染代码。 这类似于如何 packages/aladin 嵌入层 aladin-lite ——区别在于: varri-js 将自己的 HTML 页面捆绑,同时 aladin-lite 曝光一个JavaScript API.

本地测试

npm run dev

然后打开打印的本地 URL; 一个模拟 data-incoming 数据集 id(来自 GALAXY_DATASET_ID 环境变量)在dev模式下被自动注入.

安装到银河系统实例(用于开发)

银河在其中发现插件 config/plugins/visualizations/<name>/static/ 并进行阶段 输入 static/plugins/visualizations/ 在客户端构建时 :

GALAXY_ROOT=/path/to/galaxy
npm run build
mkdir -p "$GALAXY_ROOT/config/plugins/visualizations/varri"
cp -r static "$GALAXY_ROOT/config/plugins/visualizations/varri/"
cp public/varri.xml "$GALAXY_ROOT/config/plugins/visualizations/varri/static/varri.xml"
# then (re)build the Galaxy client so the plugin gets staged

许可证

varri-js (阴于下 static/vendor/varri-js/ 麻省理工学院获得许可证—— 见 static/vendor/varri-js/LICENSE。本包中的胶合码被 MIT 许可为 不错.

版本与发布记录

@galaxyproject/varri 共发布 1 个版本,首次发布于 2026/09/16;过去 12 个月发布了 1 个版本。

版本发布日期距今
0.0.0latest2026/09/162 个月前

关于 @galaxyproject/varri 的常见问题

@galaxyproject/varri 是什么?

VARRI的银河可视化 - RNA-RNA相互作用的可视化注释

如何安装 @galaxyproject/varri?

在项目目录运行 npm install @galaxyproject/varri,或使用 pnpm add / yarn add / bun add。

@galaxyproject/varri 支持 TypeScript 吗?

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

@galaxyproject/varri 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@galaxyproject/varri 可以商用吗?

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

@galaxyproject/varri 的下载量有多少?

根据 npm 官方下载统计,@galaxyproject/varri 在 2026/10/16 – 2026/11/14 这 30 天内被下载 7,969 次,日均约 266 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@galaxyproject/varri 还在维护吗?

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