BIEN_plot_sf: Download plot data from specified sf object.

View source: R/BIEN.R

BIEN_plot_sfR Documentation

Download plot data from specified sf object.

Description

BIEN_plot_sf downloads all plot data falling within a supplied sf polygon.

Usage

BIEN_plot_sf(
  sf,
  cultivated = FALSE,
  new.world = NULL,
  all.taxonomy = FALSE,
  native.status = FALSE,
  natives.only = TRUE,
  political.boundaries = TRUE,
  collection.info = FALSE,
  all.metadata = FALSE,
  ...
)

Arguments

sf

An object of class sf. Note that the projection must be WGS84.

cultivated

Return 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.

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.

all.metadata

Should additional plot metadata be returned? Default is FALSE.

...

Additional arguments passed to internal functions.

Value

A dataframe containing all plot data from within the specified sf polygon.

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

See Also

Other plot functions: BIEN_plot_country(), BIEN_plot_dataset(), BIEN_plot_datasource(), BIEN_plot_list_datasource(), BIEN_plot_list_sampling_protocols(), BIEN_plot_metadata(), BIEN_plot_name(), BIEN_plot_sampling_protocol(), BIEN_plot_state()

Examples

## Not run: 
library(sf)

BIEN_ranges_species("Carnegiea gigantea") #saves ranges to the current working directory

sf <- st_read(dsn = ".",
              layer = "Carnegiea_gigantea")

saguaro_plot_data <- BIEN_plot_sf(sf = sf)

## End(Not run)

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