Skip to contents

Conveniently plot basic US map

Source: R/plot-map.R
plot_usmap.Rd

Conveniently plot basic US map

Usage

plot_usmap(
  regions = c("states", "state", "counties", "county"),
  include = c(),
  exclude = c(),
  data = data.frame(),
  values = "values",
  theme = theme_map(),
  labels = FALSE,
  label_color = "black",
  ...
)

Arguments

regions

The region breakdown for the map, can be one of ("states", "state", "counties", "county"). The default is "states".

include

The regions to include in the resulting map. If regions is "states"/"state", the value can be either a state name, abbreviation or FIPS code. For counties, the FIPS must be provided as there can be multiple counties with the same name. If states are provided in the county map, only counties in the included states will be returned.

exclude

The regions to exclude in the resulting map. If regions is "states"/"state", the value can be either a state name, abbreviation or FIPS code. For counties, the FIPS must be provided as there can be multiple counties with the same name. The regions listed in the include parameter are applied first and the exclude regions are then removed from the resulting map. Any excluded regions not present in the included regions will be ignored.

data

A data frame containing values to plot on the map. This parameter should be a data frame consisting of two columns, a fips code (2 characters for state, 5 characters for county) and the value that should be associated with that region. The columns of data must be fips or state and the value of the values parameter.

values

The name of the column that contains the values to be associated with a given region. The default is "value".

theme

The theme that should be used for plotting the map. The default is theme_map from ggthemes.

labels

Whether or not to display labels on the map. Labels are not displayed by default. For now, labels only work for state maps. County labels may be added in the future.

label_color

The color of the labels to display. Corresponds to the color option in the aes mapping. The default is "black". Click here for more color options.

...

Other arguments to pass to ggplot2::aes(). These are often aesthetics, used to set an aesthetic to a fixed value, like color = "red" or size = 3. They affect the appearance of the polygons used to render the map (for example fill color, line color, line thickness, etc.). If any of color/colour, fill, or size are not specified they are set to their default values of color="black", fill="white", and size=0.4.

Value

A ggplot object that contains a basic US map with the described parameters. Since the result is a ggplot

object, it can be extended with more geom layers, scales, labels, themes, etc.

See also

usmap, theme

Examples

plot_usmap()

plot_usmap(regions = "states")

plot_usmap(regions = "counties")

plot_usmap(regions = "state")

plot_usmap(regions = "county")


# Output is ggplot object so it can be extended
# with any number of ggplot layers
library(ggplot2)
plot_usmap(include = c("CA", "NV", "ID", "OR", "WA")) +
  labs(title = "Western States")


# Color maps with data
plot_usmap(data = statepop, values = "pop_2015")


# Include labels on map (e.g. state abbreviations)
plot_usmap(data = statepop, values = "pop_2015", labels = TRUE)

# Choose color for labels
plot_usmap(data = statepop, values = "pop_2015", labels = TRUE, label_color = "white")