Skip to main content

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.


Build Status Coverage Status Documentation Status

Changes

3.0.45

  • Enumerator refactoring

3.0.44

  • Bug fix median measure for exporter

3.0.43

  • Median measure

3.0.42

  • Inflate cubes that are single column filters

3.0.41

  • Remove deepcopy from dimension module due to a performance issue

3.0.40

  • Fix bug with weighted vs unweighted in pairwise effect calculation

3.0.39

  • Remove cube response deepcopy due to a performance issue

3.0.38

  • Improve calculation of DoF for pairwise comparison
  • Use effective counts as column bases for DoF

3.0.37

  • Add squared counts as a cube measure
  • Enable calculating pairwise stats with effective denominator

3.0.36

  • Fix bug in pairwise sig values for means.

3.0.35

  • Fix bug where categorical dimension would sometimes be interpreted as MR_CATS.

For a complete list of changes see history.

Project details


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

cr.cube-3.0.45.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

cr.cube-3.0.45-py3-none-any.whl (114.7 kB view details)

Uploaded Python 3

File details

Details for the file cr.cube-3.0.45.tar.gz.

File metadata

  • Download URL: cr.cube-3.0.45.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for cr.cube-3.0.45.tar.gz
Algorithm Hash digest
SHA256 f38a465e7b5eba8d4f687f786e35babc367867597c1362e2a27a3782da6fbff1
MD5 559b9391f9da182c46b819f65520809d
BLAKE2b-256 53956d8dc4858063734b880a3a3890581d8e886aac6c75e1b0aa03de38d375a6

See more details on using hashes here.

File details

Details for the file cr.cube-3.0.45-py3-none-any.whl.

File metadata

  • Download URL: cr.cube-3.0.45-py3-none-any.whl
  • Upload date:
  • Size: 114.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for cr.cube-3.0.45-py3-none-any.whl
Algorithm Hash digest
SHA256 b62681997cd5799a98a8bb7a641b46b5f9641ea533faa1989f5057be647ca24c
MD5 2eee0902ff7b72a9d5d49fc0d5f99f9a
BLAKE2b-256 535afa71938b8a6e4168dd6677f341e02e695c5456d6dee71fd4bf3c072230d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page