In a histogram, rows of data_frame are grouped together into a
rectangular mark to visualize the 1D distribution of an aggregate function
histfunc (e.g. the count or sum) of the value y (or x if
orientation is "h").
Usage
px_histogram(
data_frame = NULL,
x = NULL,
y = NULL,
color = NULL,
pattern_shape = NULL,
facet_row = NULL,
facet_col = NULL,
facet_col_wrap = 0,
facet_row_spacing = NULL,
facet_col_spacing = NULL,
hover_name = NULL,
hover_data = NULL,
animation_frame = NULL,
animation_group = NULL,
category_orders = NULL,
labels = NULL,
color_discrete_sequence = NULL,
color_discrete_map = NULL,
pattern_shape_sequence = NULL,
pattern_shape_map = NULL,
marginal = NULL,
opacity = NULL,
orientation = NULL,
barmode = "relative",
barnorm = NULL,
histnorm = NULL,
log_x = FALSE,
log_y = FALSE,
range_x = NULL,
range_y = NULL,
histfunc = NULL,
cumulative = NULL,
nbins = NULL,
text_auto = FALSE,
title = NULL,
subtitle = NULL,
template = NULL,
width = NULL,
height = NULL
)Arguments
- data_frame
A data.frame, data.table, list or matrix. Needed for column names to be used in the other arguments; if
NULL, a data frame is built from the vectors given in the other arguments.- x
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to position marks along the x axis in cartesian coordinates.- y
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to position marks along the y axis in cartesian coordinates.- color
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign color to marks.- pattern_shape
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign pattern shapes to marks.- facet_row
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to facetted subplots in the vertical direction.- facet_col
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to facetted subplots in the horizontal direction.- facet_col_wrap
Maximum number of facet columns. Wraps the column variable at this width, so that the column facets span multiple rows. Ignored if 0, and forced to 0 if
facet_rowor amarginalis set.- facet_row_spacing
Spacing between facet rows, in paper units. Default is 0.03 or 0.07 when facet_col_wrap is used.
- facet_col_spacing
Spacing between facet columns, in paper units Default is 0.02.
- hover_name
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector appear in bold in the hover tooltip.- hover_data
Extra data to show in the hover tooltip: column names (a character vector or a formula such as
~c(a, b)), or a named list with column names as names and valuesTRUE(default formatting),FALSE(hide the column, e.g. one shown by default), a d3-format string such as":.3f", a vector of data, or a list of a format string orTRUEand a vector of data.- animation_frame
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to assign marks to animation frames.- animation_group
A column name in
data_frame, a vector of values, a one-sided formula evaluated indata_frame(e.g.~ log(pop)),px_constant()orpx_range(). Values from this column or vector are used to provide object-constancy across animation frames: rows with matchinganimation_groups will be treated as if they describe the same object in each frame.- category_orders
Named list mapping column names to the order of their values in axes, legends and facets, e.g.
list(day = c("Thur", "Fri", "Sat", "Sun")). By default values appear in the order first encountered, or in level order for factors.- labels
Named character vector or list mapping column names to the labels to use for axis titles, legend entries and hover text, e.g.
c(gdpPercap = "GDP per capita").- color_discrete_sequence
Character vector of colors, e.g.
px_colors$qualitative$Set1. Values ofcolorare assigned colors in order (cycling), unless set incolor_discrete_map. Defaults to the template'scolorway.- color_discrete_map
Named character vector or list mapping values of
colorto colors, overridingcolor_discrete_sequence. If the values ofcolorare colors,px_identity()(or"identity") uses them directly.- pattern_shape_sequence
Strings should define valid plotly.js patterns-shapes. When
pattern_shapeis set, values in that column are assigned patterns-shapes by cycling throughpattern_shape_sequencein the order described incategory_orders, unless the value ofpattern_shapeis a key inpattern_shape_map.- pattern_shape_map
Named character vector or list mapping values of
pattern_shapeto pattern shapes, overridingpattern_shape_sequence.px_identity()uses the values directly.- marginal
One of
"rug","box","violin", or"histogram". If set, a subplot is drawn alongside the main plot, visualizing the distribution.- opacity
Value between 0 and 1. Sets the opacity for markers.
- orientation
(default
"v"ifxandyare provided and both continuous or both categorical, otherwise"v"("h") ifx(y) is categorical andy(x) is continuous, otherwise"v"("h") if onlyx(y) is provided)- barmode
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.- barnorm
One of
"fraction"or"percent". If"fraction", the value of each bar is divided by the sum of all values at that location coordinate."percent"is the same but multiplied by 100 to show percentages.NULLwill stack up all values at each location coordinate.- histnorm
One of
"percent","probability","density", or"probability density"IfNULL, the output ofhistfuncis used as is. If"probability", the output ofhistfuncfor a given bin is divided by the sum of the output ofhistfuncfor all bins. If"percent", the output ofhistfuncfor a given bin is divided by the sum of the output ofhistfuncfor all bins and multiplied by 100. If"density", the output ofhistfuncfor a given bin is divided by the size of the bin. If"probability density", the output ofhistfuncfor a given bin is normalized such that it corresponds to the probability that a random event whose distribution is described by the output ofhistfuncwill fall into that bin.- log_x
If
TRUE, the x-axis is log-scaled in cartesian coordinates.- log_y
If
TRUE, the y-axis is log-scaled in cartesian coordinates.- range_x
If provided, overrides auto-scaling on the x-axis in cartesian coordinates.
- range_y
If provided, overrides auto-scaling on the y-axis in cartesian coordinates.
- histfunc
One of
"count","sum","avg","min", or"max". Function used to aggregate values for summarization (note: can be normalized withhistnorm).- cumulative
If
TRUE, histogram values are cumulative.- nbins
Positive integer. Sets the number of bins.
- text_auto
If
TRUEor a string, the x or y or z values will be displayed as text, depending on the orientation A string like".2f"will be interpreted as atexttemplatenumeric formatting directive.- title
The figure title.
- subtitle
The figure subtitle.
- template
A template name (see
template_names()) or a template list. Defaults todefault_template().- width
The figure width in pixels.
- height
The figure height in pixels.
Value
A go_figure().
See also
Other plotly express:
px_area(),
px_bar(),
px_bar_polar(),
px_box(),
px_choropleth(),
px_choropleth_map(),
px_density_contour(),
px_density_heatmap(),
px_density_map(),
px_ecdf(),
px_funnel(),
px_funnel_area(),
px_icicle(),
px_imshow(),
px_line(),
px_line_3d(),
px_line_geo(),
px_line_map(),
px_line_polar(),
px_line_ternary(),
px_parallel_categories(),
px_parallel_coordinates(),
px_pie(),
px_scatter(),
px_scatter_3d(),
px_scatter_geo(),
px_scatter_map(),
px_scatter_matrix(),
px_scatter_polar(),
px_scatter_ternary(),
px_strip(),
px_sunburst(),
px_timeline(),
px_treemap(),
px_violin()
Examples
px_data_tips() |> px_histogram(x = ~total_bill, color = ~sex, marginal = "rug", nbins = 20)