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.

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

harmonize ECDF between "h" and "v", removed "reversed" mode #3407

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

harmonize ECDF between "h" and "v", removed "reversed" mode #3407

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ac6bfd
harmonized ECDF between "h" and "v", removed "reversed" mode; polishe…
eisenlohr Oct 1, 2021
298dc86
reformatted with black
eisenlohr Oct 1, 2021
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
18 changes: 9 additions & 9 deletions packages/python/plotly/plotly/express/_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1336,10 +1336,7 @@ def build_dataframe(args, constructor):
var_name = df_input.columns.name
if var_name in [None, "value", "index"] or var_name in df_input:
var_name = "variable"
if constructor == go.Funnel:
wide_orientation = args.get("orientation") or "h"
else:
wide_orientation = args.get("orientation") or "v"
wide_orientation = args.get("orientation","h" if constructor == go.Funnel else "v")
args["orientation"] = wide_orientation
args["wide_cross"] = None
elif wide_x != wide_y:
Expand Down Expand Up @@ -1825,7 +1822,7 @@ def infer_config(args, constructor, trace_patch, layout_patch):
trace_patch["line"] = dict(shape=args["line_shape"])
elif "ecdfmode" in args:
trace_patch["line"] = dict(
shape="vh" if args["ecdfmode"] == "reversed" else "hv"
shape="vh" if args.get("orientation","v") == "h" else "hv"
)

if "geojson" in args:
Expand Down Expand Up @@ -2093,12 +2090,14 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
if "ecdfmode" in args:
base = args["x"] if args["orientation"] == "v" else args["y"]
var = args["x"] if args["orientation"] == "h" else args["y"]
ascending = args.get("ecdfmode", "standard") != "reversed"
group = group.sort_values(by=base, ascending=ascending)
group = group.sort_values(by=base)

head = group.head(1).copy()
head[var] = 0
group = pd.concat([head,group])

group_sum = group[var].sum() # compute here before next line mutates
group[var] = group[var].cumsum()
if not ascending:
group = group.sort_values(by=base, ascending=True)

if args.get("ecdfmode", "standard") == "complementary":
group[var] = group_sum - group[var]
Expand All @@ -2108,6 +2107,7 @@ def make_figure(args, constructor, trace_patch=None, layout_patch=None):
elif args["ecdfnorm"] == "percent":
group[var] = 100.0 * group[var] / group_sum


patch, fit_results = make_trace_kwargs(
args, trace_spec, group, mapping_labels.copy(), sizeref
)
Expand Down
87 changes: 44 additions & 43 deletions packages/python/plotly/plotly/express/_doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
ids=[
colref_type,
colref_desc,
"Values from this column or array_like are used to set ids of sectors",
"Values from this column or array_like are used to set ids of sectors.",
],
path=[
colref_list_type,
Expand Down Expand Up @@ -192,7 +192,7 @@
colref_desc,
"Values from this column or array_like are used to assign mark sizes.",
],
radius=["int (default is 30)", "Sets the radius of influence of each point."],
radius=["int (default 30)", "Sets the radius of influence of each point."],
hover_name=[
colref_type,
colref_desc,
Expand Down Expand Up @@ -227,7 +227,7 @@
],
locationmode=[
"str",
"One of 'ISO-3', 'USA-states', or 'country names'",
"One of 'ISO-3', 'USA-states', or 'country names'.",
"Determines the set of locations used to match entries in `locations` to regions on the map.",
],
facet_row=[
Expand All @@ -248,11 +248,11 @@
],
facet_row_spacing=[
"float between 0 and 1",
"Spacing between facet rows, in paper units. Default is 0.03 or 0.0.7 when facet_col_wrap is used.",
"Spacing between facet rows, in paper units. Default is 0.03 (or 0.07 when facet_col_wrap is used).",
],
facet_col_spacing=[
"float between 0 and 1",
"Spacing between facet columns, in paper units Default is 0.02.",
"float between 0 and 1 (default 0.02)",
"Spacing between facet columns, in paper units.",
],
animation_frame=[
colref_type,
Expand All @@ -271,7 +271,7 @@
],
symbol_map=[
"dict with str keys and str values (default `{}`)",
"String values should define plotly.js symbols",
"String values should define plotly.js symbols.",
"Used to override `symbol_sequence` to assign a specific symbols to marks corresponding with specific values.",
"Keys in `symbol_map` should be values in the column denoted by `symbol`.",
"Alternatively, if the values of `symbol` are valid symbol names, the string `'identity'` may be passed to cause them to be used directly.",
Expand Down Expand Up @@ -308,14 +308,14 @@
],
color_discrete_map=[
"dict with str keys and str values (default `{}`)",
"String values should define valid CSS-colors",
"String values should define valid CSS-colors.",
"Used to override `color_discrete_sequence` to assign a specific colors to marks corresponding with specific values.",
"Keys in `color_discrete_map` should be values in the column denoted by `color`.",
"Alternatively, if the values of `color` are valid colors, the string `'identity'` may be passed to cause them to be used directly.",
],
color_continuous_scale=[
"list of str",
"Strings should define valid CSS-colors",
"Strings should define valid CSS-colors.",
"This list is used to build a continuous color scale when the column denoted by `color` contains numeric data.",
"Various useful color scales are available in the `plotly.express.colors` submodules, specifically `plotly.express.colors.sequential`, `plotly.express.colors.diverging` and `plotly.express.colors.cyclical`.",
],
Expand Down Expand Up @@ -426,20 +426,21 @@
"If provided, and if `trendline` is set, all trendlines will be drawn in this color rather than in the same color as the traces from which they draw their inputs.",
],
trendline_scope=[
"str (one of `'trace'` or `'overall'`, default `'trace'`)",
"str (default `'trace'`)",
"One of `'trace'` or `'overall'`",
Copy link
Author

Choose a reason for hiding this comment

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

Forgot one "." here...

"If `'trace'`, then one trendline is drawn per trace (i.e. per color, symbol, facet, animation frame etc) and if `'overall'` then one trendline is computed for the entire dataset, and replicated across all facets.",
],
render_mode=[
"str",
"One of `'auto'`, `'svg'` or `'webgl'`, default `'auto'`",
"str (default `'auto'`)",
"One of `'auto'`, `'svg'` or `'webgl'`.",
"Controls the browser API used to draw marks.",
"`'svg`' is appropriate for figures of less than 1000 data points, and will allow for fully-vectorized output.",
"`'webgl'` is likely necessary for acceptable performance above 1000 points but rasterizes part of the output. ",
"`'auto'` uses heuristics to choose the mode.",
],
direction=[
"str",
"One of '`counterclockwise'` or `'clockwise'`. Default is `'clockwise'`",
"str (default `'clockwise'`)",
"One of '`counterclockwise'` or `'clockwise'`.",
"Sets the direction in which increasing values of the angular axis are drawn.",
],
start_angle=[
Expand All @@ -453,7 +454,7 @@
],
histnorm=[
"str (default `None`)",
"One of `'percent'`, `'probability'`, `'density'`, or `'probability density'`",
"One of `'percent'`, `'probability'`, `'density'`, or `'probability density'`.",
"If `None`, the output of `histfunc` is used as is.",
"If `'probability'`, the output of `histfunc` for a given bin is divided by the sum of the output of `histfunc` for all bins.",
"If `'percent'`, the output of `histfunc` for a given bin is divided by the sum of the output of `histfunc` for all bins and multiplied by 100.",
Expand All @@ -476,32 +477,33 @@
],
barmode=[
"str (default `'relative'`)",
"One of `'group'`, `'overlay'` or `'relative'`",
"One of `'group'`, `'overlay'` or `'relative'`.",
"In `'relative'` mode, bars are stacked above zero for positive values and below zero for negative values.",
"In `'overlay'` mode, bars are drawn on top of one another.",
"In `'group'` mode, bars are placed beside each other.",
],
boxmode=[
"str (default `'group'`)",
"One of `'group'` or `'overlay'`",
"In `'overlay'` mode, boxes are on drawn top of one another.",
"One of `'group'` or `'overlay'`.",
"In `'overlay'` mode, boxes are drawn on top of one another.",
"In `'group'` mode, boxes are placed beside each other.",
],
violinmode=[
"str (default `'group'`)",
"One of `'group'` or `'overlay'`",
"In `'overlay'` mode, violins are on drawn top of one another.",
"One of `'group'` or `'overlay'`.",
"In `'overlay'` mode, violins are drawn on top of one another.",
"In `'group'` mode, violins are placed beside each other.",
],
stripmode=[
"str (default `'group'`)",
"One of `'group'` or `'overlay'`",
"In `'overlay'` mode, strips are on drawn top of one another.",
"One of `'group'` or `'overlay'`.",
"In `'overlay'` mode, strips are drawn on top of one another.",
"In `'group'` mode, strips are placed beside each other.",
],
zoom=["int (default `8`)", "Between 0 and 20.", "Sets map zoom level."],
orientation=[
"str, one of `'h'` for horizontal or `'v'` for vertical. ",
"str",
"One of `'h'` for horizontal or `'v'` for vertical.",
"(default `'v'` if `x` and `y` are provided and both continous or both categorical, ",
"otherwise `'v'`(`'h'`) if `x`(`y`) is categorical and `y`(`x`) is continuous, ",
"otherwise `'v'`(`'h'`) if only `x`(`y`) is provided) ",
Expand All @@ -511,28 +513,28 @@
"If `True`, an extra line segment is drawn between the first and last point.",
],
line_shape=["str (default `'linear'`)", "One of `'linear'` or `'spline'`."],
fitbounds=["str (default `False`).", "One of `False`, `locations` or `geojson`."],
basemap_visible=["bool", "Force the basemap visibility."],
fitbounds=["str (default `False`)", "One of `False`, `'locations'` or `'geojson'`."],
basemap_visible=["boolean", "Force the basemap visibility."],
scope=[
"str (default `'world'`).",
"One of `'world'`, `'usa'`, `'europe'`, `'asia'`, `'africa'`, `'north america'`, or `'south america'`"
"One of `'world'`, `'usa'`, `'europe'`, `'asia'`, `'africa'`, `'north america'`, or `'south america'`."
"Default is `'world'` unless `projection` is set to `'albers usa'`, which forces `'usa'`.",
],
projection=[
"str ",
"One of `'equirectangular'`, `'mercator'`, `'orthographic'`, `'natural earth'`, `'kavrayskiy7'`, `'miller'`, `'robinson'`, `'eckert4'`, `'azimuthal equal area'`, `'azimuthal equidistant'`, `'conic equal area'`, `'conic conformal'`, `'conic equidistant'`, `'gnomonic'`, `'stereographic'`, `'mollweide'`, `'hammer'`, `'transverse mercator'`, `'albers usa'`, `'winkel tripel'`, `'aitoff'`, or `'sinusoidal'`"
"str",
"One of `'equirectangular'`, `'mercator'`, `'orthographic'`, `'natural earth'`, `'kavrayskiy7'`, `'miller'`, `'robinson'`, `'eckert4'`, `'azimuthal equal area'`, `'azimuthal equidistant'`, `'conic equal area'`, `'conic conformal'`, `'conic equidistant'`, `'gnomonic'`, `'stereographic'`, `'mollweide'`, `'hammer'`, `'transverse mercator'`, `'albers usa'`, `'winkel tripel'`, `'aitoff'`, or `'sinusoidal'`."
"Default depends on `scope`.",
],
center=[
"dict",
"Dict keys are `'lat'` and `'lon'`",
"Dict keys are `'lat'` and `'lon'`.",
"Sets the center point of the map.",
],
mapbox_style=[
"str (default `'basic'`, needs Mapbox API token)",
"Identifier of base map style, some of which require a Mapbox API token to be set using `plotly.express.set_mapbox_access_token()`.",
"Allowed values which do not require a Mapbox API token are `'open-street-map'`, `'white-bg'`, `'carto-positron'`, `'carto-darkmatter'`, `'stamen-terrain'`, `'stamen-toner'`, `'stamen-watercolor'`.",
"Allowed values which do require a Mapbox API token are `'basic'`, `'streets'`, `'outdoors'`, `'light'`, `'dark'`, `'satellite'`, `'satellite-streets'`.",
"Allowed values that do not require a Mapbox API token are `'open-street-map'`, `'white-bg'`, `'carto-positron'`, `'carto-darkmatter'`, `'stamen-terrain'`, `'stamen-toner'`, `'stamen-watercolor'`.",
"Allowed values that do require a Mapbox API token are `'basic'`, `'streets'`, `'outdoors'`, `'light'`, `'dark'`, `'satellite'`, `'satellite-streets'`.",
],
points=[
"str or boolean (default `'outliers'`)",
Expand All @@ -558,12 +560,12 @@
"boolean (default `False`)",
"If `True`, histogram values are cumulative.",
],
nbins=["int", "Positive integer.", "Sets the number of bins."],
nbinsx=["int", "Positive integer.", "Sets the number of bins along the x axis."],
nbinsy=["int", "Positive integer.", "Sets the number of bins along the y axis."],
nbins=["int", "Positive integer", "Sets the number of bins."],
nbinsx=["int", "Positive integer", "Sets the number of bins along the x axis."],
nbinsy=["int", "Positive integer", "Sets the number of bins along the y axis."],
branchvalues=[
"str",
"'total' or 'remainder'",
"One of `'total'` or `'remainder'`.",
"Determines how the items in `values` are summed. When"
"set to 'total', items in `values` are taken to be value"
"of all its descendants. When set to 'remainder', items"
Expand All @@ -574,22 +576,21 @@
maxdepth=[
"int",
"Positive integer",
"Sets the number of rendered sectors from any given `level`. Set `maxdepth` to -1 to render all the"
"levels in the hierarchy.",
"Sets the number of rendered sectors from any given `level`.",
"Set `maxdepth` to -1 to render all the levels in the hierarchy.",
],
ecdfnorm=[
"string or `None` (default `'probability'`)",
"One of `'probability'` or `'percent'`",
"str or `None` (default `'probability'`)",
"One of `'probability'` or `'percent'`.",
"If `None`, values will be raw counts or sums.",
"If `'probability', values will be probabilities normalized from 0 to 1.",
"If `'percent', values will be percentages normalized from 0 to 100.",
],
ecdfmode=[
"string (default `'standard'`)",
"One of `'standard'`, `'complementary'` or `'reversed'`",
"str (default `'standard'`)",
"One of `'standard'` or `'complementary'`.",
"If `'standard'`, the ECDF is plotted such that values represent data at or below the point.",
"If `'complementary'`, the CCDF is plotted such that values represent data above the point.",
"If `'reversed'`, a variant of the CCDF is plotted such that values represent data at or above the point.",
"If `'complementary'`, the ECDF is plotted such that values represent data above the point.",
],
)

Expand Down