Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
wckdouglas committed May 21, 2024
1 parent 207262b commit 291c689
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/colors.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
::: ridgeplot.colors
::: src.ridgeplot.colors
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ This is a simple module for plotting [ridgeplot](https://clauswilke.com/blog/201

Ridgeplot is a great data visualization technique to compare distributions from multiple groups at the same time, and was first introduced in 2017 as joy plot:

<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I hereby propose that we call these &quot;joy plots&quot; <a href="https://twitter.com/hashtag/rstats?src=hash&amp;ref_src=twsrc%5Etfw">#rstats</a> <a href="https://t.co/uuLGpQLAwY">https://t.co/uuLGpQLAwY</a></p>&mdash; Jenny Bryan (@JennyBryan) <a href="https://twitter.com/JennyBryan/status/856674638981550080?ref_src=twsrc%5Etfw">April 25, 2017</a></blockquote>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I hereby propose that we call these &quot;joy plots&quot; <a href="https://twitter.com/hashtag/rstats?src=hash&amp;ref_src=twsrc%5Etfw">#rstats</a> <a href="https://t.co/uuLGpQLAwY">https://t.co/uuLGpQLAwY</a></p>&mdash; Jenny Bryan (@JennyBryan) <a href="https://twitter.com/JennyBryan/status/856674638981550080?ref_src=twsrc%5Etfw">April 25, 2017</a></blockquote>

[ridgeplot-py](https://pypi.org/project/ridgeplot-py/) provides a simple API to produce matplotlib-compatible ridgeplots, as well as a handy [ColorEncoder](https://github.com/wckdouglas/ridgeplot-py/blob/0198628ce0622e2e7f4f4e9284165d5d09324ca9/ridgeplot/colors.py#L117) class with scikit-learn syntax for manipulating color annotations in a consistent way [through out manuscripts or presentations].


# Modules

1. [colors](colors.md)
2. [ridgeplot](ridge_plot.md)
3. [stats](stats.md)
4. [dotted_heatmap](dotted_heatmap.md)
2 changes: 1 addition & 1 deletion docs/ridge_plot.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
::: ridgeplot.ridge_plot
::: src.ridgeplot.ridge_plot
2 changes: 1 addition & 1 deletion docs/stats.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
::: ridgeplot.stats
::: src.ridgeplot.stats

0 comments on commit 291c689

Please sign in to comment.