Crunch.io Cube library
Project description
crunch-cube
Open Source Python implementation of the API for working with CrunchCubes
Introduction
This package contains the implementation of the CrunchCube API. It is used to extract useful information from CrunchCube responses (we'll refer to them as cubes in the subsequent text). Cubes are obtained from the Crunch.io platform, as JSON responses to the specific queries created by the user. These queries specify which data the user wants to extract from the Crunch.io system. The most common usage is to obtain the following:
- Cross correlation between different variable
- Margins of the cross tab cube
- Proportions of the cross tab cube (e.g. proportions of each single element to the entire sample size)
- Percentages
When the data is obtained from the Crunch.io platform, it needs to be interpreted to the form that's convenient for a user. The actual shape of the cube JSON contains many internal details, which are not of essence to the end-user (but are still necessary for proper cube functionality).
The job of this library is to provide a convenient API that handles those
intricacies, and enables the user to quickly and easily obtain (extract) the
relevant data from the cube. Such data is best represented in a table-like
format. For this reason, the most of the API functions return some form of the
ndarray type, from the numpy package. Each function is explained in greater
detail, uner its own section, under the API subsection of this document.
Installation
The cr.cube package can be installed by using the pip install:
pip install cr.cube
For developers
For development mode, cr.cube needs to be installed from the local checkout
of the crunch-cube repository. It is strongly advised to use virtualenv.
Assuming you've created and activated a virtual environment venv, navigate
to the top-level folder of the repo, on the local file system, and run:
pip install -e .
or
python setup.py develop
Running tests
To setup and run tests, you will need to install cr.cube as well as testing
dependencies. To do this, from the root directory, simply run:
pip install -e .[testing]
And then tests can be run using py.test in the root directory:
pytest
Usage
After the cr.cube package has been successfully installed, the usage is as
simple as:
>>> 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
Tabular, or matrix, representation of the cube. The detailed description can be found here.
margin
Calculates margins of the cube. The detailed description can be found here.
proportions
Calculates proportions of single variable elements to the whole sample size. The detailed description can be found here.
percentages
Calculates percentages of single variable elements to the whole sample size. The detailed description can be found here.
Changes
2.3.7
- Allow sorting by label
2.3.6
- Fix row share of sum denominator
2.3.5
- Fix scorecards with MR insertions
2.3.4
- Consolidate stipe counts
- Sort by value stripe
2.3.3
- Fix Python 2 syntax issue
2.3.2
- Allow hiding MR insertions
2.3.1
- Consolidate weighted counts
- Fix bug with weighted counts for numeric arrays
2.3.0
- Consolidation of weighted counts such that bases are no longer calculated by adding across subvariables.
- Removed the
_Slice.table_margin_unprunedproperty, instead use_Slice.table_margin_rangeto get the unpruned range of table margins.
2.2.3
- More sort-by-value support including a fallback to payload order
For a complete list of changes see history.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cr.cube-2.3.7.tar.gz.
File metadata
- Download URL: cr.cube-2.3.7.tar.gz
- Upload date:
- Size: 978.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 667d3778e5cc5a022986026930dc20c5d527aa34f83730e2eac18a93504997f1 |
|
| MD5 | 9a98cc301517d79a6bb4f7a96d4b645d |
|
| BLAKE2b-256 | de726c7a56b5951b1a38ec6f9d7dee12cfcd901bbe7441c45705edbf97dbec5b |
File details
Details for the file cr.cube-2.3.7-py3-none-any.whl.
File metadata
- Download URL: cr.cube-2.3.7-py3-none-any.whl
- Upload date:
- Size: 104.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a584b387fb0d83f1f1fdf889f228f580fea259e7dff2a4f8fea9e5b0fd5e64a6 |
|
| MD5 | 893c1ba1fb8533f78caea9763f68b709 |
|
| BLAKE2b-256 | e2586a93e4d2cc9328bbeb84577cf39d761ec3dc8cf3d3d78525f7a8247c3d71 |
