BIEN_ranges_sf: Download range maps that intersect a user-supplied sf object.

In BIEN: Tools for Accessing the Botanical Information and Ecology Network Database

Download range maps that intersect a user-supplied sf object.

Description

BIEN_ranges_sf extracts range maps that intersect a specified simple features (sf) object.

Usage

BIEN_ranges_sf(
  sf,
  directory = NULL,
  species.names.only = FALSE,
  return.species.list = TRUE,
  crop.ranges = FALSE,
  include.gid = FALSE,
  ...
)

Arguments

sf	An object of class sf.
directory	Directory that range maps should be saved in. If none is specified, range maps will be saved in the current working directory.
species.names.only	Return species names rather than spatial data? Default is FALSE.
return.species.list	Should a species list be returned in addition to downloading range maps? Default is FALSE
crop.ranges	Should the ranges be cropped to the focal area? Default is FALSE.
include.gid	Should the files returned have a unique GID appended to them? This is needed if downloading multiple maps for the same species.
...	Additional arguments passed to internal functions.

Value

All range maps that intersect the user-supplied sf object.

Note

Details on the construction of BIEN range maps is available at https://bien.nceas.ucsb.edu/bien/biendata/bien-3/

See Also

Other range functions: BIEN_ranges_box(), BIEN_ranges_genus(), BIEN_ranges_intersect_species(), BIEN_ranges_list(), BIEN_ranges_load_species(), BIEN_ranges_shapefile_to_skinny(), BIEN_ranges_skinny_ranges_to_richness_raster(), BIEN_ranges_species(), BIEN_ranges_species_bulk()

Examples

## Not run: 

# Here we use a range map as our example polygon

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

# Read in the polygon  with sf   
sf <- sf::st_read(dsn = ".",
                  layer = "Carnegiea_gigantea")

BIEN_ranges_sf(sf = sf,
               limit = 10) 
               # We use the limit argument to return only 10 range maps.
               # Omit the limit argument to get all ranges

#Note that this will save many shapefiles to the working directory.

## End(Not run)

BIEN documentation built on April 3, 2025, 9:22 p.m.