centroid_labels: Retrieve centroid labels

In pdil/usmapdata: Mapping Data for 'usmap' Package

Retrieve centroid labels

Description

Retrieve centroid labels

Usage

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

Arguments

regions	The region breakdown for the map, can be one of ("states", "state", "counties", "county"). The default is "states".
as_sf	Defunct, this parameter no longer has any effect and will be removed in the future.
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.

pdil/usmapdata documentation built on Jan. 22, 2025, 10:52 p.m.