-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
12 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,25 @@ | ||
<img src="https://github.com/Phlya/adjustText/blob/master/adjustText_logo.svg" width="200"> | ||
|
||
[![Documentation Status](https://readthedocs.org/projects/adjusttext/badge/?version=latest)](http://adjusttext.readthedocs.io/en/latest/?badge=latest) | ||
|
||
Inspired by **ggrepel** package for R/ggplot2 (https://github.com/slowkow/ggrepel) | ||
![Alt text](examples/mtcars.gif "Labelled mtcars dataset") | ||
|
||
The idea is that often when we want to label multiple points on a graph the text will start heavily overlapping with both other labels and data points. This can be a major problem requiring manual solution. However this can be largely automatized by smart placing of the labels (difficult) or iterative adjustment of their positions to minimize overlaps (relatively easy). This library (well... script) implements the latter option to help with matplotlib graphs. Usage is very straightforward with usually pretty good results with no tweaking (most important is to just make text slightly smaller than default and maybe the figure a little larger). However the algorithm itself is highly configurable, but there is no documentation now, just see the docstring to the main function `adjust_text`. | ||
The idea is that often when we want to label multiple points on a graph the text will start heavily overlapping with both other labels and data points. This can be a major problem requiring manual solution. However this can be largely automatized by smart placing of the labels (difficult) or iterative adjustment of their positions to minimize overlaps (relatively easy). This library (well... script) implements the latter option to help with matplotlib graphs. Usage is very straightforward with usually pretty good results with no tweaking (most important is to just make text slightly smaller than default and maybe the figure a little larger). However the algorithm itself is highly configurable for complicated plots. | ||
|
||
There is a simple documentation now, thanks to Christophe Van Neste @beukueb! | ||
|
||
Should be installable from pypi! | ||
``` | ||
pip install adjustText | ||
``` | ||
|
||
See wiki for some basic introduction, and more advanced usage examples [here]. | ||
For the lates version from github: | ||
``` | ||
pip install https://github.com/Phlya/adjustText/archive/master.zip | ||
``` | ||
|
||
See [wiki] for some basic introduction, and more advanced usage examples [here]. | ||
|
||
[wiki]: https://github.com/Phlya/adjustText/wiki | ||
[here]: https://github.com/Phlya/adjustText/blob/master/examples/Examples.ipynb |