BIEN_occurrence_state: Extract species occurrence records by state.

View source: R/BIEN.R

BIEN_occurrence_stateR Documentation

Extract species occurrence records by state.

Description

BIEN_occurrence_state extracts occurrences records for the specified state(s).

Usage

BIEN_occurrence_state(
  country = NULL,
  state = NULL,
  country.code = NULL,
  state.code = NULL,
  cultivated = FALSE,
  new.world = NULL,
  all.taxonomy = FALSE,
  native.status = FALSE,
  natives.only = TRUE,
  observation.type = FALSE,
  political.boundaries = FALSE,
  collection.info = FALSE,
  ...
)

Arguments

country

A single country or vector of countries.

state

A state or vector of states (or other primary political divisions, e.g. provinces).

country.code

A single country (or other primary administrative boundary) code or a vector of country codes equal in length to the vector of states/province codes.

state.code

A single state/province code, or a vector of states/province codes.

cultivated

Return known cultivated records as well? Default is FALSE.

new.world

NULL (The default) returns global records, TRUE returns only New World, and FALSE only Old World.

all.taxonomy

Return all taxonomic information? This includes the raw data as well as the "scrubbed" data.

native.status

Return information on introduction status? The default value is FALSE. A value of TRUE also returns additional information on introduction status.

natives.only

Exclude detected introduced species? Default is TRUE.

observation.type

Return information on type of observation (i.e. specimen vs. plot)? The default value is FALSE.

political.boundaries

Return information on political boundaries for an observation? The default value is FALSE.

collection.info

Return additional information about collection and identification? The default value is FALSE.

...

Additional arguments passed to internal functions.

Value

Dataframe containing occurrence records for the specified states/provinces.

Note

US FIA coordinates have been fuzzed and swapped, for more details see: https://www.fia.fs.fed.us/tools-data/spatial/Policy/index.php

Political division (or political division code) spelling needs to be exact and case-sensitive, see BIEN_metadata_list_political_names for a list of political divisions and associated codes.

This function requires you supply either 1) a single country with one or more states, or 2) vectors of equal length for each political level.

See Also

Other occurrence functions: BIEN_occurrence_box(), BIEN_occurrence_country(), BIEN_occurrence_county(), BIEN_occurrence_family(), BIEN_occurrence_genus(), BIEN_occurrence_records_per_species(), BIEN_occurrence_sf(), BIEN_occurrence_species()

Examples

## Not run: 
BIEN_occurrence_state("United States","Rhode Island")
state_vector<-c("Rhode Island","Maryland")
BIEN_occurrence_state(country="United States",state=state_vector)
## End(Not run)

BIEN documentation built on Jan. 6, 2023, 9:06 a.m.