Skip to content
📐 Transform percentage-based units into a 2d space to evaluate changes in distribution with both magnitude and direction.
Python Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bonvoyage
figures
logo
testing
.editorconfig
.gitignore
.travis.yml
AUTHORS.md
CONTRIBUTING.md
HISTORY.rst
LICENSE
MANIFEST.in
Makefile
README.md
_config.yml
conda_requirements.txt
requirements.txt
setup.cfg
setup.py

README.md

Bonvoyage logo: A bottle of champagne as the y=-x + 1 line on a Cartesian plane

Build Status

What is bonvoyage?

Transform percentage-based units into a 2d space to evaluate changes in distribution with both magnitude and direction.

Installation

To install anchor, we recommend using the Anaconda Python Distribution and creating an environment, so the anchor code and dependencies don't interfere with anything else. Here is the command to create an environment:

conda create -n anchor-env pandas numpy matplotlib seaborn scikit-learn

Stable (recommended)

To install this code from the Python Package Index, you can install on the command line via pip:

pip install bonvoyage

Bleeding-edge (for the brave)

To install this code, clone this github repository and use pip to install

git clone git@github.com:yeolab/bonvoyage
cd bonvoyage
pip install .  # The "." means "install *this*, the folder where I am now"

Usage

To use bonvoyage to get waypoints, you want your data to be a pandas DataFrame of shape (n_samples, n_features)

import bonvoyage

wp = bonvoyage.Waypoints()
waypoints = wp.fit_transform(data)

bonvoyage is modeled after scikit-learn in is method of creating a transforming object and then running fit_transform() to perform the computation.

To plot the waypoints, use a waypointplot, which can do either "scatter" or "hex" plot types. By default, hexbin plots are used:

import bonvoyage

bonvoyage.waypointplot(waypoints)

Hexbin waypoints

You can also specify to use scatter:

import bonvoyage

bonvoyage.waypointplot(waypoints, kind='scatter')

Scatter waypoints

To add color, give a series or other groupby-able object:

import bonvoyage

bonvoyage.waypointplot(waypoints, kind='scatter', features_groupby=modalities)

Scatter, colored by modality waypoints

History

1.0.0 (2017-06-28)

  • Added tests and examples

0.1.0 (2015-09-15)

  • First release on PyPI.
You can’t perform that action at this time.