load_stixels: Load summary data for eBird Status and Trends stixels

In CornellLabofOrnithology/stemhelper: Access and Analyze eBird Status and Trends Data

Load summary data for eBird Status and Trends stixels

Description

eBird Status and Trends divides space and time into variably sized "stixels" within which individual base models are fit. The process of stixelization is performed many times and the prediction at any given point is the median of the predictions from all the stixels that that point falls in. This function loads summary statistics for each stixel, for example, the size of the stixels, the number of observations within each stixel, and a suite of predictive performance metrics (PPMs) for the model fit within that stixel.

Usage

load_stixels(path, ext, return_sf = FALSE)

Arguments

path	character; directory that the Status and Trends data for a given species was downloaded to. This path is returned by ebirdst_download() or get_species_path().
ext	ebirdst_extent object; the spatiotemporal extent to filter the data to. The spatial component of the extent object must be provided in unprojected, latitude-longitude coordinates.
return_sf	logical; whether to return an sf object of spatial points rather then the default data frame.

Value

Data frame, or sf object if return_sf = TRUE, containing stixel summary data. Data are organized with one stixel per row and each stixel identified by a unique stixel_id, the centroid of each stixel in space and time is specified by lat, lon, and date.

Examples

## Not run: 
# download example data
path <- ebirdst_download("example_data", tifs_only = FALSE)
# or get the path if you already have the data downloaded
path <- get_species_path("example_data")

# load stixel summary information
stixels <- load_stixels(path)
dplyr::glimpse(stixels)

## End(Not run)

CornellLabofOrnithology/stemhelper documentation built on Feb. 5, 2023, 9:59 a.m.