Crunch.io Cube库
项目描述
crunch-cube
CrunchCubes操作的API的开源Python实现
简介
本包包含CrunchCube API的实现。它用于从CrunchCube响应中提取有用信息（在后续文本中我们将它们称为立方体）。立方体是从Crunch.io平台获得的，作为用户创建的特定查询的JSON响应。这些查询指定用户想要从Crunch.io系统中提取哪些数据。最常用的用途是获取以下信息
- 不同变量之间的交叉相关性
- 交叉表立方体的边缘
- 交叉表立方体的比例（例如，每个单独元素相对于整个样本大小的比例）
- 百分比
当数据从Crunch.io平台获得时，需要将其解释为用户方便的形式。实际的立方体JSON形状包含许多内部细节，这些细节对于最终用户来说不是本质的（但对于正确地使用立方体功能仍然是必要的）。
这个库的工作是提供一个方便的API来处理这些复杂性，并使用户能够快速轻松地从立方体中获取（提取）相关数据。此类数据最好以表格形式表示。因此，API的大部分函数都返回ndarray类型，来自numpy包。每个函数的详细说明可以在文档的API子部分下的单独章节中找到。
安装
可以使用pip install安装cr.cube包
pip install cr.cube
对于开发者
对于开发模式，需要从本地crunch-cube存储库的本地checkout安装cr.cube。强烈建议使用virtualenv。假设您已创建并激活了虚拟环境venv，导航到本地文件系统中的存储库顶层文件夹，并运行
pip install -e .
或
python setup.py develop
运行测试
要设置和运行测试，需要安装cr.cube以及测试依赖项。为此，从根目录，只需运行
pip install -e .[testing]
然后可以在根目录中使用py.test运行测试
pytest
用法
在成功安装cr.cube包后，用法非常简单
>>> from cr.cube.cube import Cube
>>> ### Obtain the crunch cube JSON payload using app.crunch.io, pycrunch, rcrunch or scrunch
>>> ### And store it in the 'cube_JSON_response' variable
>>> cube = Cube(cube_JSON_response)
>>> print(cube)
Cube(name='MyCube', dimension_types='CAT x CAT')
>>> cube.counts
np.array([[1169, 547],
[1473, 1261]])
API
as_array
以表格或矩阵形式表示的立方体。详细信息请参阅此处。
margin
计算立方体的边缘。详细信息请参阅此处。
proportions
计算单个变量元素相对于整个样本大小的比例。详细信息请参阅此处。
percentages
计算单个变量元素相对于整个样本大小的百分比。详细信息请参阅此处。
更改
3.0.45
- 枚举器重构
3.0.44
- 修复导出器中中值测量的错误
3.0.43
- 中值测量
3.0.42
- 膨胀单列筛选器的立方体
3.0.41
- 由于性能问题，从维度模块中删除
deepcopy
3.0.40
- 修复配对效应计算中加权与非加权之间的错误
3.0.39
- 由于性能问题，删除立方体响应的
deepcopy
3.0.38
- 改进配对比较的DoF计算
- 将有效计数作为DoF的列基础
3.0.37
- 添加平方计数作为立方体度量
- 启用使用有效分母计算配对统计
3.0.36
- 修复均值配对 sig 值中的错误
3.0.35
- 修复有时将分类维度解释为
MR_CATS的错误
有关更改的完整列表，请参阅历史记录。
下载文件
下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
