jStat 技术文档

1. 安装指南

1.1 通过 npm 安装

要通过 npm 安装 jStat，请在终端中运行以下命令：

npm install --save jstat

1.2 在浏览器中使用

jStat 可以在浏览器中直接使用。你可以通过 CDN 引入 jStat，例如：

<script src="//cdn.jsdelivr.net/npm/jstat@latest/dist/jstat.min.js"></script>

1.3 使用 RequireJS

如果你使用 RequireJS，需要配置 shim，如下所示：

requirejs.config({
  paths: {
    'jstat': 'path/to/jstat/dist/jstat.min'
  },
  shim: {
    jstat: {
      exports: ['j$', 'jStat'],
      init: function () {
        return {
          j$: j$,
          jStat: jStat
        };
      }
    }
  }
});

1.4 构建前提

要构建 jStat，你需要以下工具：

• GNU make 3.8 或更高版本
• Node.js 0.2 或更高版本
• Git 1.7 或更高版本

Windows 用户

1. 安装 msysgit、GNU make for Windows 和 Node.js 的二进制版本。确保所有三个包安装在同一位置。
2. 安装 Cygwin，并确保安装了 git、make 和 which 包，然后按照 Node.js 构建指南 或安装 Node.js 的二进制版本。

Mac OS 用户

1. 安装 Xcode（可以从 Mac OS 安装 DVD 或 Apple 的 Xcode 网站 下载）。
2. 安装 Homebrew，然后运行 brew install git 和 brew install node。

Linux/BSD 用户

使用适当的包管理器安装 make、git 和 node，或者从源代码构建。

2. 项目的使用说明

2.1 在浏览器中使用 jStat

在浏览器中使用 jStat 时，jStat 对象会被添加到 window 对象中。例如：

<script src="components/jstat.js"></script>
<script>
  var jstat = this.jStat(dataset);
  data[i]['cum'] = jstat.normal(jstat.mean(), jstat.stdev()).cdf(data[i].x);
</script>

2.2 在 Node.js 中使用 jStat

在 Node.js 中使用 jStat 时，需要引用子对象：

var { jStat } = require('jstat');

3. 项目 API 使用文档

jStat 提供了丰富的统计函数，包括概率密度函数（pdf）、累积分布函数（cdf）、逆函数、均值、众数、方差和样本函数等。以下是一些常用的 API 示例：

3.1 计算均值

var mean = jStat.mean(dataset);

3.2 计算标准差

var stdev = jStat.stdev(dataset);

3.3 计算正态分布的累积分布函数

var cdfValue = jStat.normal(mean, stdev).cdf(x);

3.4 计算泊松分布的概率密度函数

var pdfValue = jStat.poisson.pdf(k, lambda);

4. 项目安装方式

4.1 通过 npm 安装

npm install --save jstat

4.2 通过 CDN 引入

<script src="//cdn.jsdelivr.net/npm/jstat@latest/dist/jstat.min.js"></script>

4.3 手动构建

1. 克隆 jStat 仓库：

   git clone git://github.com/jstat/jstat.git
   

2. 安装依赖：

   npm install
   

3. 构建 jStat：

   make
   

   构建后的文件将位于 dist/ 目录中。

4.4 运行测试

执行所有测试：

make test

或者运行特定测试：

cd test/<subdir>
node <some_test>-test.js

5. 贡献指南

jStat 遵循 v8 JavaScript 编码规范。提交 pull request 时，请不要包含 dist/*.js 文件，这些文件会在发布时重新编译。

6. 加入社区

欢迎加入 jStat 的 邮件列表 或在 IRC 的 #jstat 频道中提问和讨论。