In a choropleth map, each row of data_frame is represented by a colored
region mark on a map.
Usage
px_choropleth(
data_frame = NULL,
lat = NULL,
lon = NULL,
locations = NULL,
locationmode = NULL,
geojson = NULL,
featureidkey = NULL,
color = 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,
custom_data = NULL,
animation_frame = NULL,
animation_group = NULL,
category_orders = NULL,
labels = NULL,
color_discrete_sequence = NULL,
color_discrete_map = NULL,
color_continuous_scale = NULL,
range_color = NULL,
color_continuous_midpoint = NULL,
projection = NULL,
scope = NULL,
center = NULL,
fitbounds = NULL,
basemap_visible = NULL,
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.- lat
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 according to latitude on a map.- lon
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 according to longitude on a map.- locations
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 to be interpreted according tolocationmodeand mapped to longitude/latitude.- locationmode
One of "ISO-3", "USA-states", or 'country names' Determines the set of locations used to match entries in
locationsto regions on the map.- geojson
GeoJSON as a list (e.g. from
jsonlite::read_json()), with features whose ids are referenced bylocations.- featureidkey
Path to field in GeoJSON feature object with which to match the values passed in to
locations.The most common alternative to the default is of the form'properties.<key>.- 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.- 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.- custom_data
Column names (a character vector or a formula such as
~c(a, b)), or a list of column names, formulas and vectors. Values from these columns are added to the traces'customdata(e.g. for use in Shiny events) without appearing in the hover tooltip.- 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.- color_continuous_scale
Character vector of colors, e.g.
px_colors$sequential$Viridis, or the name of a scale in px_colors. Used whencoloris numeric. Defaults to the template's sequential colorscale.- range_color
If provided, overrides auto-scaling on the continuous color scale.
- color_continuous_midpoint
If set, computes the bounds of the continuous color scale to have the desired midpoint. Setting this value is recommended when using
plotly.express.colors.divergingcolor scales as the inputs tocolor_continuous_scale.- projection
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 onscope.- scope
One of
"world","usa","europe","asia","africa","north america", or"south america"Default is"world"unlessprojectionis set to"albers usa", which forces"usa".- center
Dict keys are
"lat"and"lon"Sets the center point of the map.- fitbounds
One of
FALSE,locationsorgeojson.- basemap_visible
Force the basemap visibility.
- 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_map(),
px_density_contour(),
px_density_heatmap(),
px_density_map(),
px_ecdf(),
px_funnel(),
px_funnel_area(),
px_histogram(),
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_gapminder(year = 2007) |>
px_choropleth(locations = ~iso_alpha, color = ~lifeExp, hover_name = ~country)