Package 'usmapdata'

Title: Mapping Data for 'usmap' Package
Description: Provides a container for data used by the 'usmap' package. The data used by 'usmap' has been extracted into this package so that the file size of the 'usmap' package can be reduced greatly. The data in this package will be updated roughly once per year as new map data files are provided by the US Census Bureau.
Authors: Paolo Di Lorenzo [aut, cre]
Maintainer: Paolo Di Lorenzo <[email protected]>
License: GPL (>= 3)
Version: 1.0.0.9000
Built: 2026-06-03 06:40:09 UTC
Source: https://github.com/pdil/usmapdata

Help Index

Years for which US map data is available

Description

Years for which US map data is available

Usage

available_map_years()

Value

A numeric vector of available map data years, sorted in descending order.

Examples

available_map_years()

Retrieve centroid labels

Description

Retrieve centroid labels

Usage

centroid_labels(
  regions = c("states", "state", "counties", "county"),
  data_year = NULL
)

Arguments

regions

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

The year for which to obtain map data. If the value is NULL, the most recent year's data is used. If the provided year is not found from the available map data sets, the next most recent year's data is used. This can be used if an older data set is being plotted on the US map so that the data matches the map more accurately. Therefore, the provided value should match the year of the plotted data set. The default is NULL, i.e. the most recent available year is used.

Value

An sf data frame of state or county centroid labels and positions relative to the coordinates returned by the us_map function.

Retrieve state and county FIPS codes

Description

Retrieve state and county FIPS codes

Usage

fips_data(
  regions = c("states", "state", "counties", "county"),
  data_year = NULL
)

Arguments

regions

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

The year for which to obtain map data. If the value is NULL, the most recent year's data is used. If the provided year is not found from the available map data sets, the next most recent year's data is used. This can be used if an older data set is being plotted on the US map so that the data matches the map more accurately. Therefore, the provided value should match the year of the plotted data set. The default is NULL, i.e. the most recent available year is used.

Value

An data frame of FIPS codes of the desired regions.

Examples

str(fips_data())

state_fips <- fips_data()
county_fips <- fips_data(regions = "counties")

Retrieve US map data

Description

Retrieve US map data

Usage

us_map(
  regions = c("states", "state", "counties", "county"),
  include = c(),
  exclude = c(),
  data_year = NULL
)

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 take precedence over regions listed in exclude. If both parameters include the same region(s) they will be included in the map.
data_year

The year for which to obtain map data. If the value is NULL, the most recent year's data is used. If the provided year is not found from the available map data sets, the next most recent year's data is used. This can be used if an older data set is being plotted on the US map so that the data matches the map more accurately. Therefore, the provided value should match the year of the plotted data set. The default is NULL, i.e. the most recent available year is used.

Value

An sf data frame of US map coordinates divided by the desired regions.

Examples

str(us_map())

df <- us_map(regions = "counties")
west_coast <- us_map(include = c("CA", "OR", "WA"))

excl_west_coast <- us_map(exclude = c("CA", "OR", "WA"))

ct_counties_as_of_2022 <- us_map(regions = "counties", include = "CT", data_year = 2022)

usmapdata: Mapping Data for usmap Package

Description

It is usually difficult or inconvenient to create US maps that include Alaska, Hawaii, and even Puerto Rico in a convenient spot. All map data frames produced by this package use the US National Atlas Equal Area projection.

Map data frames

Alaska, Hawaii, and Puerto Rico have been manually moved to a new location so that their new coordinates place them to the bottom-left corner of the map. These maps can be accessed by using the us_map function.

The function provides the ability to retrieve maps with either state borders or county borders using the regions parameter for convenience.

States (or counties) can be included such that all other states (or counties) are excluded using the include parameter.

Author(s)

Paolo Di Lorenzo

References

Rudis B (2014). “Moving The Earth (well, Alaska & Hawaii) With R.” https://rud.is/b/2014/11/16/moving-the-earth-well-alaska-hawaii-with-r/.

See Also

Helpful links: