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

improve histogram docs #3101

Closed
wants to merge 2 commits into from
Closed

improve histogram docs #3101

wants to merge 2 commits into from

Conversation

Moelf
Copy link
Member

@Moelf Moelf commented Oct 27, 2020

No description provided.

@codecov
Copy link

codecov bot commented Oct 27, 2020

Codecov Report

Merging #3101 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3101   +/-   ##
=======================================
  Coverage   62.77%   62.77%           
=======================================
  Files          25       25           
  Lines        6426     6426           
=======================================
  Hits         4034     4034           
  Misses       2392     2392           
Impacted Files Coverage Δ
src/examples.jl 61.76% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8ce603d...1ee8c19. Read the comment docs.

@@ -813,7 +813,9 @@ const _examples = PlotExample[
),
PlotExample( # 38
"Histogram2D (complex values)",
"",
"""
Other possible `normed` mode include `:probability`, where bin area (volumn) is not divided.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a bit unclear to me, what you are trying to say here

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the _make_hist takes a normed argument, the example only shows normed=true, but under the hood, it calls the normalize! from StatsBase, with normalization mode default to :pdf, but there's actually another normalization mode, which is called :probability

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these modes are quite good covered in https://docs.juliaplots.org/latest/generated/attributes_series/.
This example aims to show how complex data can be visualized as a 2D Histogram.
I agree it would be good to also have a graphic that compares the different modes (like in spirit with JuliaPlots/PlotDocs.jl#217), but here is not the right place.
Adding a different example would also be fine.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, I see, makes sense

@Moelf Moelf closed this Oct 27, 2020
@BeastyBlacksmith BeastyBlacksmith deleted the Moelf-patch-1 branch May 14, 2021 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants