Skip to content

Figure.histogram: Let parameter 'cumulative' support Pythonic arguments #4881

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.

Sign up for GitHub

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

Open
seisman wants to merge 3 commits into
base: main
Choose a base branch
from
+6 −5
Open

Figure.histogram: Let parameter 'cumulative' support Pythonic arguments #4881

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9e44f7
Figure.histogram: Let parameter 'cumulative' support readable arguments
seisman Sep 4, 2026
e29c0b2
Fix typos
seisman Sep 4, 2026
8f6b4b9
Polish docstring
seisman Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions pygmt/src/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
F="center",
L="extreme",
N="distribution",
Q="cumulative",
S="stairs",
T="series",
Z="histtype",
Expand All @@ -45,6 +44,7 @@ def histogram(
cmap: str | bool = False,
pen: str | None = None,
fill: str | None = None,
cumulative: bool | Literal["reverse"] = False,
projection: str | None = None,
region: Sequence[float | str] | str | None = None,
frame: Frame | Axis | Literal["none"] | str | Sequence[str] | bool = False,
Expand All @@ -67,6 +67,7 @@ def histogram(
- E = bar_width, **+o**: bar_offset
- G = fill
- J = projection
- Q = cumulative
- R = region
- V = verbose
- W = pen
Expand Down Expand Up @@ -112,10 +113,9 @@ def histogram(
* 0 = mean and standard deviation [Default];
* 1 = median and L1 scale (1.4826 \* median absolute deviation; MAD);
* 2 = LMS (least median of squares) mode and scale.
cumulative : bool or str
[**r**].
Draw a cumulative histogram by passing ``True``. Use **r** to display
a reverse cumulative histogram.
cumulative
Draw a cumulative histogram. Set it to ``"reverse"`` to draw the reverse
cumulative histogram instead.
extreme : str
**l**\|\ **h**\|\ **b**.
The modifiers specify the handling of extreme values that fall outside
Expand Down Expand Up @@ -174,6 +174,7 @@ def histogram(
Alias(bar_offset, name="bar_offset", prefix="+o"),
],
G=Alias(fill, name="fill"),
Q=Alias(cumulative, name="cumulative", mapping={"reverse": "r"}),
W=Alias(pen, name="pen"),
).add_common(
B=frame,
Expand Down
Loading