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.crunch_cube import CrunchCube

### Obtain the crunch cube JSON from the Crunch.io
### And store it in the 'cube_JSON_response' variable

cube = CrunchCube(cube_JSON_response)
cube.as_array()

### Outputs:
#
# np.array([
#     [5, 2],
#     [5, 3]
# ])

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

1.8.0

  • Major refactor of Dimension class

1.7.3

  • Implement pruning for index tables

1.7.2

  • Implement correct index table functionality
  • Deprecate old index functionality

1.7.1 Fix index error

  • Fix peculiar case of CA x CAT (single elem) index error
  • Support with unit tests
  • Create base for fixing exporter issues

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-1.8.0.tar.gz (810.6 kB view details)

Uploaded Source

Built Distribution

cr.cube-1.8.0-py2.py3-none-any.whl (62.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: cr.cube-1.8.0.tar.gz
  • Upload date:
  • Size: 810.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.10

File hashes

Hashes for cr.cube-1.8.0.tar.gz
Algorithm Hash digest
SHA256 753d84eedbe2c8ee10a2256d5a71dde0e74fbeef456a4e4c6b2da152668498de
MD5 eec07a93f4fb5b6366ab627377716eba
BLAKE2b-256 9426d47e2b0ee7eac842f59a8087029932dcd8967e87ac7921c0a97c59084c93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cr.cube-1.8.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 62.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.10

File hashes

Hashes for cr.cube-1.8.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 be4d8c4d139ada408c2875b567d5271e88c68adee7700de9416b9589419ea4d9
MD5 b90f5e1987f222fb222f2aac2525e215
BLAKE2b-256 2700b101f561cfb793b41a60685f8c22c613516c5cb793d4d8a53c9486238c62

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