# @gmod/ucsc-hub 中文文档

规范地址：https://npmcn.com/package/%40gmod/ucsc-hub/

版本：2\.0\.13
npm 元数据更新时间：2026-08-10T16:47:42.456Z
中文译文更新时间：2026-11-16T17:09:01.940Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gmod/ucsc-hub
原文对照：https://npmcn.com/package/%40gmod/ucsc-hub/?lang=original
项目主页：https://github.com/GMOD/ucsc-hub-js#readme
源码仓库：https://github.com/GMOD/ucsc-hub-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：86.7 kB，60 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2018-12-28T22:16:25.703Z
- 最新版本发布：2026-08-10T16:47:42.079Z
- 近 30 天下载量：32496（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 9 个）

## 中文简介

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

## 安装

```sh
npm install @gmod/ucsc-hub
```

也可以使用：`pnpm add @gmod/ucsc-hub`、`yarn add @gmod/ucsc-hub`、`bun add @gmod/ucsc-hub`

## README

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

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

[![NPM version](https://img.shields.io/npm/v/@gmod/ucsc-hub.svg?logo=npm&style=flat-square)](https://npmjs.org/package/@gmod/ucsc-hub) ![Build Status](https://img.shields.io/github/actions/workflow/status/GMOD/ucsc-hub-js/publish.yml?branch=main)

## 安装

```sh
npm install @gmod/ucsc-hub
```

## 使用量

见 [UCSC 轨道中心文档](https://genome.ucsc.edu/goldenpath/help/hgTrackHubHelp.html) 用于中枢.txt,基因组.txt,并跟踪Db.txt文件格式.

```js
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 密码

#### 目录

-   [基因组文件](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-genomesfile)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters)
-   [枢纽文件](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-hubfile)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-1)
-   [拉菲尔](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-rafile)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-2)
    -   [属性](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-properties)
-   [拉斯坦萨](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-rastanza)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-3)
-   [单文件Hub](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-singlefilehub)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-4)
-   [音轨Db文件](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-trackdbfile)
    -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-5)
    -   [设置](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-settings)
        -   [参数](https://npmcn.com/package/%40gmod/ucsc-hub/#readme-parameters-6)

### 基因组文件

**扩展 RaFile**

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

#### 参数

-   `genomesFile` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\>\] (简体中文)** 作为字符串的基因组.txt文件(可选,默认) `[]`(中文(简体) )

-   掷出 **[错误](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** 如果基因组的第一行.txt文件没有从"基因组"开始 < genome name> 或如果其条目无效

### 枢纽文件

**扩展拉斯坦扎**

Class 代表一个 huble.txt 文件 .

#### 参数

-   `hubFile` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\>\] (简体中文)** 作为字符串的站点.txt文件(可选,默认) `[]`(中文(简体) )

-   掷出 **[错误](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** 如果站.txt文件的第一行不以"站"开头,则丢出 <hub name>,如果它有无效的条目,或者缺少必要的条目

### 拉菲尔

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

#### 参数

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

#### 属性

-   `nameKey` **(单位:千美元)[未定义](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined) | [字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)(中文(简体) )** 所有星座一行的钥匙(`undefined` 如果星座没有 线条尚未打开.

-   掷出 **[错误](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** 如果添加了空的星座, 如果第一个密钥值对中的密钥 每个星座都不一样 如果两个星座的值是相同的 键值对在他们的第一行.

### 拉斯坦萨

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

#### 参数

-   `stanza` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\>\] (简体中文)** (可选,默认) `[]`(中文(简体) )
-   `options` **{检查缩进 : [布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)? ? ? 吗, 跳过变量 : [布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean){\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢?**

### 单文件Hub

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

#### 参数

-   `hubText` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**

### 音轨Db文件

**扩展 RaFile**

代表 trackDb.txt 文件的类 .

#### 参数

-   `trackDbFile` **(单位:千美元)[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\>\] (简体中文)** 作为字符串的 trackDb.txt 文件(可选,默认) `[]`(中文(简体) )
-   `options` **有吗?**

-   掷出 **[错误](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** 如果“ track” 不是每个音轨的第一个密钥, 或是缺少一个音轨, 则丢弃 需要的密钥

#### 设置

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

##### 参数

-   `trackName` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 音轨名称

-   掷出 **[错误](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)** 如果音轨名称在音轨Db中不存在, 则丢弃

## 许可证

麻省理工学院 [通用模型生物数据库项目](http://gmod.org/wiki/Main_Page)

## 出版

[受托出版](https://docs.npmjs.com/about-trusted-publishing) 通过 GitHub 行动.

```bash
pnpm version patch  # or minor/major
```

## 常见问题

### @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 和提交记录判断。

