Skip to main content

Create broken axes

Project description

# brokenaxes

![brokenaxes logo. Reference: http://www.brianhensley.net/2012/02/python-controlling-spi-bus-on.html](broken_python_snake.png)

brokenaxes makes matplotlib plots with breaks in the axes for showing data across a discontinuous range.

[![PyPI](https://img.shields.io/pypi/v/brokenaxes.svg?style=plastic)](https://pypi-hypernode.com/pypi/brokenaxes)

## Installation
I recommend the [Anaconda python distribution](http://continuum.io/downloads)
```
pip install brokenaxes
```

## Usage
```python
import matplotlib.pyplot as plt
from brokenaxes import brokenaxes
import numpy as np

fig = plt.figure(figsize=(5,2))
bax = brokenaxes(xlims=((0, .1), (.4, .7)), ylims=((-1, .7), (.79, 1)), hspace=.05)
x = np.linspace(0, 1, 100)
bax.plot(x, np.sin(10 * x), label='sin')
bax.plot(x, np.cos(10 * x), label='cos')
bax.legend(loc=3)
bax.set_xlabel('time')
bax.set_ylabel('value')
```
![example1](example1.png)

Create subplots:

```python
from brokenaxes import brokenaxes
from matplotlib.gridspec import GridSpec
import numpy as np

sps1, sps2 = GridSpec(2,1)

bax = brokenaxes(xlims=((.1, .3),(.7, .8)), subplot_spec=sps1)
x = np.linspace(0, 1, 100)
bax.plot(x, np.sin(x*30), ls=':', color='m')

x = np.random.poisson(3, 1000)
bax = brokenaxes(xlims=((0, 2.5), (3, 6)), subplot_spec=sps2)
bax.hist(x, histtype='bar')
```
![example2](example2.png)

### Features:
* Break x and y axes.
* Supports multiple breaks on a single axis.
* Automatically scales axes according to relative ranges.
* Plot multiple lines.
* Legend with positioning relative to entire broken axes object
* x and y label centered to entire plot
* Make brokenaxes object a subplot itself with `matplotlib.GridSpec.subplot_spec`.
* xlims and ylims may be datetime.datetime objects

### Life advice
Please use this tool wisely. Any data visaulization techique can be used to elucidate trends in the data, and can be used to manipulate and mislead. The latter is particularly true for broken axes plots, so please try to use them responsibly. Other than that, this software is free to use for any purpose.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

brokenaxes-0.3.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

brokenaxes-0.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file brokenaxes-0.3.tar.gz.

File metadata

  • Download URL: brokenaxes-0.3.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for brokenaxes-0.3.tar.gz
Algorithm Hash digest
SHA256 1ccb903470912d6fb0c74a4b9f23c6a225415afd3bf9600b24eb2ed4a7e324b5
MD5 7e005f184d902fde9ca38ecaa3c9792e
BLAKE2b-256 b6de2682fc85489c547d7171b7642f84c92ce68dbf982f3b45536ded4a522e2e

See more details on using hashes here.

File details

Details for the file brokenaxes-0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for brokenaxes-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f949ada2920214c55650c118ce6bc68993e391e482540933deed94ed9d2d31ea
MD5 3e45e4a7a37cbf911e553a540cf084a6
BLAKE2b-256 aa90e7c9cd499530cf608f8d6634b3b041c4d0af81bf670e47d4e0a6ab4330d4

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