GNRS_super_simple: Standardize political division names

Description Usage Arguments Value Note Examples

View source: R/gnrs_super_simple.R

Description

GNRS_super_simple returns standardized political division names (according to geonames.org).

Usage

1
2
3
4
5
6
7
GNRS_super_simple(
  country = NULL,
  state_province = NULL,
  county_parish = NULL,
  user_id = NULL,
  ...
)

Arguments

country

A single country or a vector of countries. If a vector, length must equal length of species vector.

state_province

A single state/province or a vector of states. If a vector, length must equal length of species vector.

county_parish

A single county/parish or a vector of counties. If a vector, length must equal length of species vector.

user_id

A single identifier or vector of identifiers. This field is assigned if not provided and is used to maintain record order.

...

Additional parameters passed to internal functions

Value

Dataframe containing GNRS results.

Note

The fields the GNRS takes as input are titled "country", "state_province", and "county_parish" for simplicity, but these field actually refer to 0th-, 1st-, and 2nd-order political division, respectively. In the case of some exceptions (e.g. the UK) this distinction becomes important (e.g. Ireland is a 1st-order political division and should be treated as a "state_province" and cannot be matched as a country.)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 ## Not run: 

 results <- GNRS_super_simple(country = "United States of America")
 results <- GNRS_super_simple(
             country = "United States",
             state_province = "Arizona",
             county_parish = "Pima County")


## End(Not run)

GNRS documentation built on Oct. 14, 2021, 1:09 a.m.