map_with_data: Join county or state level data to US map data

Description Usage Arguments Value Examples

View source: R/join-data.R

Description

Join county or state level data to US map data

Usage

1
map_with_data(data, values = "values", include = c(), exclude = c(), na = NA)

Arguments

data

The data that should be joined to a US 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. If both fips and state are provided, this function uses the fips.

values

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

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.

na

The value to be inserted for states or counties that don't have a value in data. This value must be of the same type as the value column of data.

Value

A data frame composed of the map data frame (from us_map) except an extra column containing the values in data is included.

The result can be plotted using ggplot2. See us_map or plot_usmap for more details.

Examples

1
2
3
4
5
state_data <- data.frame(fips = c("01", "02", "04"), values = c(1, 5, 8))
df <- map_with_data(state_data, na = 0)

state_data <- data.frame(state = c("AK", "CA", "Utah"), values = c(6, 9, 3))
df <- map_with_data(state_data, na = 0)

usmap documentation built on Jan. 21, 2021, 5:06 p.m.