gmba_read: Read the GMBA Inventory v2.0 to R

View source: R/gmba_read.R

gmba_readR Documentation

Read the GMBA Inventory v2.0 to R

Description

Read the GMBA Inventory v2.0 (standard extend, all layers) to R, from the web or the local drive. This function is to be used without an assignment operator (e.g. "<-").

Usage

gmba_read(source = "web", extend = "standard", local = NULL, timeout = 300)

Arguments

source

Character string, options are "web" (Default) or "local"

extend

Character string, options are "standard" (Default) or "broad". Check https://www.earthenv.org/mountains for the details on the options. Ignored when source is set to "local"

local

Character string containing the path to the inventory shapefile on the local drive. Only needed when source is set to "local". Default is set to NULL

timeout

Numeric time in seconds, after what time period the function should stop trying to download the GMBA Inventory v2.0. Default is set to 300 i.e. 5 minutes

Value

gmba_inv(), a function containing the GMBA Inventory v2.0

References

https://www.earthenv.org/mountains

Examples

## Not run: 
gmba_read()
gmba_read("web", extend = "broad")
gmba_read(source = "local", local = "GMBA_Inventory_v2.0.shp")

## End(Not run)

GMBA-biodiversity/gmbaR documentation built on Feb. 13, 2025, 8:44 a.m.