# @greenelab/hclust 中文文档

规范地址：https://npmcn.com/package/%40greenelab/hclust/

版本：0\.0\.1
npm 元数据更新时间：2022-04-05T15:59:47.510Z
中文译文更新时间：2026-11-17T06:29:58.352Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：433 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2020-03-24T23:14:14.554Z
- 最新版本发布：2020-11-25T17:17:56.402Z
- 近 30 天下载量：5623（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

JavaScript 中的分级群集

## 安装

```sh
npm install @greenelab/hclust
```

也可以使用：`pnpm add @greenelab/hclust`、`yarn add @greenelab/hclust`、`bun add @greenelab/hclust`

## README

### 括号

[分层排列](https://en.wikipedia.org/wiki/Hierarchical_clustering) 在 Java 脚本中

受麻省理工学院许可的启发 [h 组群.js](https://github.com/cmpolis/hcluster.js) 以 [@ 克里斯波利斯](https://twitter.com/chrispolis)。 。 。 . [见下文两者的比较](https://npmcn.com/package/%40greenelab/hclust/#readme-comparison-with-hclusterjs)。 。 。 .

* * *

### 使用量

#### 浏览器

```html
<script src="hclust.min.js"></script>
<script>
  hclust.clusterData(...);
  hclust.euclideanDistance(...);
  hclust.avgDistance(...);
</script>
```

#### 节点

`npm install @greenelab/hclust`

或者说

`yarn add @greenelab/hclust`

接下来

```javascript
import { clusterData } from 'hclust';
import { euclideanDistance } from 'hclust';
import { avgDistance } from 'hclust';
```

* * *

### `clusterData({ data, key, distance, linkage, onProgress })`

#### 参数

**`data`**

您要分组的数据, 格式:

```javascript
[
  ...
  [ ... 1, 2, 3 ...],
  [ ... 1, 2, 3 ...],
  [ ... 1, 2, 3 ...],
  ...
]
```

或如果 `key` 参数指定 :

```javascript
[
  ...
  { someKey: [ ... 1, 2, 3 ...] },
  { someKey: [ ... 1, 2, 3 ...] },
  { someKey: [ ... 1, 2, 3 ...] },
  ...
]
```

外部阵列中的条目可视为 `rows` 和每个条目 `row` 数组可视为 `cols`。 。 。 . 每个 `row` 应拥有相同数目的 `cols`。 。 。 .

_默认值 :_ `[]`

**`key`**

A 类 `string` 键以指定要提取的值 `data` 阵列. 如果省略,则, `data` 假定为数组. 如果指定, `data` 假设为对象的数组,每个对象都有包含该对象的值的密钥 `row`。 。 。 .

_默认值 :_ `''`

**`distance`**

计算两个等分向量之间的距离的函数,用于计算距离矩阵,格式为:

```javascript
function (arrayA, arrayB) { return someNumber; }
```

该函数得到两个等长的数字数组(ints或浮点)并应当返回一个数字(int或浮点).

_默认值 :_ `euclideanDistance` 从此 `hclust` 软件包

**`linkage`**

基于一个距离矩阵计算成对集群之间的距离的函数,用于确定链接标准,其格式为:

```javascript
function (arrayA, arrayB, distanceMatrix) { return someNumber; }
```

该函数得到两套指数和计算出每个数据和其他数据之间的距离矩阵. 该函数应返回一个数字( 插入或浮动)

_默认值 :_ `averageDistance` 从此 `hclust` 软件包

**`onProgress`**

整个分组中多次调用的一个函数,通过分组提供当前的进展,格式如下:

```javascript
function (progress) { }
```

该函数在 `0` 财务报告和审定财务报表 `1`。 。 。 .

_默认值 :_ 内部职能 `console.log`'是进展

**说明:** [`postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/postMessage) 在与 `onProgress`,如果脚本运行为 [网络工人](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)。 。 。 .

#### 回返

```javascript
const { clusters, distances, order, clustersGivenK } = clusterData(...);
```

**`clusters`**

生成的集群树,格式如下:

```javascript
{
  indexes: [ ... Number, Number, Number ... ],
  height: Number,
  children: [ ... {}, {}, {} ... ]
}

```

**`distances`**

格式中的计算距离矩阵:

```javascript
[
  ...
  [ ... Number, Number, Number ...],
  [ ... Number, Number, Number ...],
  [ ... Number, Number, Number ...]
  ...
]
```

**`order`**

以原始数据数组索引为格式的数据新顺序:

```javascript
[ ... Number, Number, Number ... ]
```

等值为 `clusters.indexes` 财务报告和审定财务报表 `clustersGivenK[1]`。 。 。 .

**`clustersGivenK`**

原始数据数组索引中的树切片列表,其中索引=K,格式为:

```javascript
[
  [], // K = 0
  [ [] ], // K = 1
  [ [], [] ], // K = 2
  [ [], [], [] ], // K = 3
  [ [], [], [], [] ], // K = 4
  [ [], [], [], [], [] ] // K = 5
  ...
]
```

* * *

### `euclideanDistance(arrayA, arrayB)`

计算 [欧几利得相距](https://en.wikipedia.org/wiki/Euclidean_distance) 介于两个等分向量之间.

* * *

### `avgDistance(arrayA, arrayB, distanceMatrix)`

根据距离矩阵计算成对集群之间的平均距离.

* * *

### 与 [h 组群.js](https://github.com/cmpolis/hcluster.js)

-   此软件包不重复结果中原始数据集中的项目 . 有关结果按原始数据集或距离矩阵的指数列出.
-   这个软件包使用更现代的JavaScript语法和做法来使代码更清洁更简单.
-   此软件包提供了 `onProgress` 调用和呼叫 `postMessage` 用于: [网络工人](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)。 。 。 . 因为集成用大数据集需要很长的时间,所以你可能想作为网络工人运行它,这样浏览器就不会被长时间地冻结了,而你可能需要一个回调,这样就可以给用户提供其进度的视觉反馈.
-   这个软件包做了一些性能优化,比如通过大集去除不必要的循环. 它已经在各种OS(Windows,Mac,Linux,iOS,Android),设备(台式电脑,笔记本电脑,移动),浏览器(Chrome,Firefox,Safari),背景(主线,网络工人),以及托管地点(本地,在线)等测试过. 结果大相径庭,对硬件,cpu核心,浏览器执行等细节可能敏感. 但总的来说,这个包裹比 `hcluster.js`,在不同程度上,并且总是至少是平均表现的. Chrome似乎看到性能收益最多(可达10x,当行数高时),而Firefox似乎没有看到收益.
-   此软件包不触及输入数据对象,而 `hcluster.js` 软件包. D3常期望您直接对数据对象进行突变,这在JavaScript中通常被认为是不良的做法. 相反,这个软件包返回集群算法(包括距离矩阵)的有用数据,并允许您根据需要对数据对象进行突变或不突变.
-   这个包没有了 `minDistance` 或者说 `maxDistance` 包含在 `hcluster.js`,因为 [参考文献](https://onlinelibrary.wiley.com/doi/abs/10.1002/9780470316801.ch5) - 其效力不如 `averageDistance`。 。 。 .

* * *

### 更改图书馆

1.  [安装节点](https://nodejs.org/en/download/)
2.  [安装 Yarn](https://classic.yarnpkg.com/en/docs/install)
3.  清除这回波,在命令终端导航
4.  运行 `yarn install` 安装此软件包的依赖性
5.  向 `./src/hclust.js`
6.  运行 `yarn test` 以自动重建库并运行测试套件
7.  运行 `yarn build` 来重建库,并将编译的内容输出到 `./build/hclust.min.js`
8.  必要时, 承诺更改重投 . _执行之前一定要运行构建命令;不会自动发生._

* * *

### 类似图书馆

[cmpolis/h 组群.js](https://github.com/cmpolis/hcluster.js) [harthur/ 分组](https://github.com/harthur/clustering) [mljs/ 包含](https://github.com/mljs/hclust) [数学功用/等级-集群](https://github.com/math-utils/hierarchical-clustering)

* * *

### 进一步阅读

这个 [澳大利亚地名](https://onlinelibrary.wiley.com/doi/abs/10.1002/9780470316801.ch5) (AGGlomerative NESting)方法; 连续合并最不相差的节点.

## 常见问题

### @greenelab/hclust 是什么？

JavaScript 中的分级群集

### 如何安装 @greenelab/hclust？

在项目目录运行 npm install @greenelab/hclust，或使用 pnpm add / yarn add / bun add。

### @greenelab/hclust 支持 TypeScript 吗？

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

### @greenelab/hclust 支持 ESM 还是 CommonJS？

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

### @greenelab/hclust 可以商用吗？

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

### @greenelab/hclust 的下载量有多少？

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

### @greenelab/hclust 还在维护吗？

最新版本 0\.0\.1 发布于 2020/11/26（5 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/03/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

