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

Uploaded Source

Built Distribution

brokenaxes-0.3.1-py2-none-any.whl (6.7 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for brokenaxes-0.3.1.tar.gz
Algorithm Hash digest
SHA256 55c9ae071f6702ce14c6e20391521d0ef0a8c9cfc5b5ba76fb6b1d50d89dfc25
MD5 d56f18b63b9e2bce13ab9e361e013f11
BLAKE2b-256 c5410a8839699a98387d63d027909626920df7a7d6634d2a0a3bc1096626954c

See more details on using hashes here.

File details

Details for the file brokenaxes-0.3.1-py2-none-any.whl.

File metadata

File hashes

Hashes for brokenaxes-0.3.1-py2-none-any.whl
Algorithm Hash digest
SHA256 ec45d7a9595665302a73f81dfaaccf6ba6783bff7236c5f8a5dc7f016b31561c
MD5 d7f39f6a65fe41280b8cc19d1fe46bbf
BLAKE2b-256 5bd16a8a2e65bae25fd624e86c3bee2af16d7dd6532c5c0896e21c180fe78174

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