getStateCode: Return state ISO codes at specified locations

View source: R/getStateCode.R

getStateCodeR Documentation

Return state ISO codes at specified locations

Description

Uses spatial comparison to determine which 'state' polygons the locations fall into and returns the ISO 3166 2-character state code strings for those polygons.

Specification of countryCodes limits spatial searching to the specified countries and greatly improves performance.

If allData = TRUE, additional data is returned.

Usage

getStateCode(
  longitude = NULL,
  latitude = NULL,
  datasetName = "NaturalEarthAdm1",
  countryCodes = NULL,
  allData = FALSE,
  useBuffering = FALSE
)

Arguments

longitude

Vector of longitudes in decimal degrees East.

latitude

Vector of latitudes in decimal degrees North.

datasetName

Name of spatial dataset to use.

countryCodes

Vector of ISO 3166-1 alpha-2 country codes.

allData

Logical specifying whether a full dataframe should be returned.

useBuffering

Logical flag specifying the use of location buffering to find the nearest polygon if no target polygon is found.

Value

Vector of ISO-3166-2 alpha-2 state codes.

See Also

getSpatialData

Examples

## Not run: 
library(MazamaSpatialUtils)
setSpatialData("~/Data/Spatial_0.8")

loadSpatialData("NaturalEarthAdm1")

longitude <- seq(-140, -90)
latitude <- seq(20, 70)
getStateCode(longitude, latitude)

## End(Not run)

MazamaSpatialUtils documentation built on Sept. 8, 2023, 5:22 p.m.