@gmod/ucsc-hub

中文文档
2.0.13发布于 2026/08/11MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 3.2万

在节点或浏览器中读取和写入 UCSC 轨迹和组装中心文件

中文使用文档
文档目录11 节
  1. 安装
  2. 使用量
  3. API 密码
  4. 基因组文件
  5. 枢纽文件
  6. 拉菲尔
  7. 拉斯坦萨
  8. 单文件Hub
  9. 音轨Db文件
  10. 许可证
  11. 出版

{\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}我还不知道你是谁 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}

在节点或浏览器中读取并写入 UCSC 轨道和组装中枢文件.

NPM version Build Status

安装

npm install @gmod/ucsc-hub

使用量

见 UCSC 轨道中心文档 用于中枢.txt,基因组.txt,并跟踪Db.txt文件格式.

import {
  HubFile,
  GenomesFile,
  TrackDbFile,
  SingleFileHub,
} from '@gmod/ucsc-hub'

const hub = new HubFile(hubText)
console.log(hub.data.shortLabel)

const genomes = new GenomesFile(genomesText)
console.log(genomes.data['hg38'].data.trackDb)

const trackDb = new TrackDbFile(trackDbText)
console.log(trackDb.settings('myTrack'))

const singleHub = new SingleFileHub(hubText)
console.log(singleHub.hubData, singleHub.genome, singleHub.tracks)

API 密码

目录

基因组文件

扩展 RaFile

代表基因组.txt文件的类.

参数

  • genomesFile (单位:千美元)字符串 | 阵列<字符串>] (简体中文) 作为字符串的基因组.txt文件(可选,默认) [](中文(简体) )
  • 掷出 错误 如果基因组的第一行.txt文件没有从"基因组"开始 < genome name> 或如果其条目无效

枢纽文件

扩展拉斯坦扎

Class 代表一个 huble.txt 文件 .

参数

  • hubFile (单位:千美元)字符串 | 阵列<字符串>] (简体中文) 作为字符串的站点.txt文件(可选,默认) [](中文(简体) )
  • 掷出 错误 如果站.txt文件的第一行不以"站"开头,则丢出 <hub name>,如果它有无效的条目,或者缺少必要的条目

拉菲尔

代表 ra 文件的类 。 每个文件由多个结构组成,以及 每个星座用一行或多行空白分隔。 每个星座都存放在 带有密钥的映射是stanza中第一个密钥值对的值. 这个 常规地图方法可以在文件中使用。 另一种方法 add() 实值 可用以取出一行原始文本并将其分解为密钥和值 把它们加到课上 这事应该先解决 set() 可能的话,就如 进行的有效性检查多于使用 set()。 。 。 .

参数

  • raFile (单位:千美元)字符串 | 阵列<字符串>] (简体中文) Ra 文件, 或作为单字符串, 或用单音节的字符串数组 每个条目。 既支持LF也支持CRLF线性终点. (可选,默认) [](中文(简体) )
  • options 对象
    • options.checkIndent 布尔 [真实] - 检查文件中的音阶是否一致缩进 并跟踪缩进

属性

  • nameKey (单位:千美元)未定义 | 字符串(中文(简体) ) 所有星座一行的钥匙(undefined 如果星座没有 线条尚未打开.
  • 掷出 错误 如果添加了空的星座, 如果第一个密钥值对中的密钥 每个星座都不一样 如果两个星座的值是相同的 键值对在他们的第一行.

拉斯坦萨

代表ra文件stanza的班级. 每条地盘线被分割成钥匙 值并存储为地图,所以通常的地图方法可以在stanza上被使用.

参数

  • stanza (单位:千美元)字符串 | 阵列<字符串>] (简体中文) (可选,默认) [](中文(简体) )
  • options {检查缩进 : 布尔? ? ? 吗, 跳过变量 : 布尔{\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}你觉得呢?

单文件Hub

类代表包含所有章节的" single-file" sult.txt 文件 在一个文件中的中枢.

参数

音轨Db文件

扩展 RaFile

代表 trackDb.txt 文件的类 .

参数

  • trackDbFile (单位:千美元)字符串 | 阵列<字符串>] (简体中文) 作为字符串的 trackDb.txt 文件(可选,默认) [](中文(简体) )
  • options 有吗?
  • 掷出 错误 如果“ track” 不是每个音轨的第一个密钥, 或是缺少一个音轨, 则丢弃 需要的密钥

设置

获取所有音轨条目,包括母音轨条目,并设置更接近的条目 超越更远的地方

参数
  • 掷出 错误 如果音轨名称在音轨Db中不存在, 则丢弃

许可证

麻省理工学院 通用模型生物数据库项目

出版

受托出版 通过 GitHub 行动.

pnpm version patch  # or minor/major

版本与发布记录

@gmod/ucsc-hub 共发布 25 个版本,首次发布于 2018/12/29;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.13latest2026/08/113 个月前
2.0.122026/07/253 个月前
2.0.112026/06/204 个月前
2.0.102026/06/204 个月前
2.0.92026/05/195 个月前
2.0.72026/05/195 个月前

关于 @gmod/ucsc-hub 的常见问题

@gmod/ucsc-hub 是什么?

在节点或浏览器中读取和写入 UCSC 轨迹和组装中心文件

如何安装 @gmod/ucsc-hub?

在项目目录运行 npm install @gmod/ucsc-hub,或使用 pnpm add / yarn add / bun add。

@gmod/ucsc-hub 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gmod/ucsc-hub 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gmod/ucsc-hub 可以商用吗?

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

@gmod/ucsc-hub 的下载量有多少?

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

@gmod/ucsc-hub 还在维护吗?

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