Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Boxplot and violinplot gallery #3733

Closed
rasbt opened this issue Oct 28, 2014 · 4 comments
Closed

Boxplot and violinplot gallery #3733

rasbt opened this issue Oct 28, 2014 · 4 comments

Comments

@rasbt
Copy link
Contributor

rasbt commented Oct 28, 2014

Hi,
@tacaswell asked my recently if I could add my little boxplot gallery to "the main repo's docs".
I would be happy to contribute to matplotlib since I am a big fan of it, however, I haven't contributed to matplotlib before and it would be nice if you can help me a little bit here.

I think those boxplot examples would maybe better be suited for the examples/statistics directory, but I see that there is already a boxplot and violin plot tutorial. So, if you need this tutorial at all under those circumstances let me know where I should put it and which format you'd prefer.

Thanks

@tacaswell
Copy link
Member

What I particularly liked about your example was the explanation of what all the parts of the boxplot mean and the comparison of the violin plot vs box plots.

I also think your examples which are (mostly) one plot per example are much easier to read and sort out which code goes to what image than the current multi-panel examples. If you would be willing to merge your examples into the existing examples (how ever you see fit!) that would be awesome.

As for format, the current doc building system can only deal with stand-alone scripts so that is probably the lowest common denominator. There was some talk at scipy of putting examples/tutorials in ipython notebooks, but that has not had much motion on it.

@rasbt
Copy link
Contributor Author

rasbt commented Oct 28, 2014

My current idea would be

  1. to add the code of the last part of my ipynb (violin and boxplot next to each other) as violin_vs_boxplot_demo.py to /examples/statistics.py with a short explanatory comment on top of the code.

  2. add another script boxplot_color_demo.py with colored rectangular boxplots and notch-shaped boxplots

And I have a few more questions then ;)

Q1: Do I have to provide the images separately somewhere, or are they automatically generated?

Q2: I didn't use matplotlib "for [the] explanation of what all the parts of the boxplot mean " but annotated it in Keynote. How would I go about adding this to the example gallery (assuming that the png files are automatically generated)?

@tacaswell
Copy link
Member

The pngs are automatically generated from the scripts.

The explanatory figure should go in the more prosey section of the docs anyway, maybe in one of the faqs? There you can put the png in the _static folder and just reference it from the rst.

@rasbt
Copy link
Contributor Author

rasbt commented Oct 28, 2014

I submitted a pull request including points 1) and 2) and also added the boxplot explanatory figure to the _static folder. However, I don't really know where/how to put it exactly in the faqs yet (and I don't want to mess things up). I think it would be best to close this issue here and continue the discussion under the pull request.

@rasbt rasbt closed this as completed Oct 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants