ms_load_variables: load MacroSheds variables data table

View source: R/ms_load_variables.R

ms_load_variablesR Documentation

load MacroSheds variables data table

Description

Load a data.frame of MacroSheds variables with information on variable codes, units, and more. Visit EDI for complete metadata.

Usage

ms_load_variables(var_set = "timeseries")

Arguments

var_set

character. One of "timeseries", "timeseries_by_site", or "ws_attr". If "timeseries", basic metadata for core MacroSheds time series variables will be returned. If "timeseries_by_site", a more complete catalog of variable availability per site will be returned. If "ws_attr", metadata for MacroSheds watershed attributes will be returned.

Details

Variable metadata are included as an .RData file with the macrosheds package, and are loaded into the macrosheds namespace on library(macrosheds). This function simply retrieves a data.frame from the macrosheds namespace and makes it available in the global environment.

Value

returns a data.frame of variables, codes, units, and other metadata.

Author(s)

Wes Slaughter, weston.slaughter@duke.edu

Mike Vlah, vlahm13@gmail.com

Spencer Rhea

See Also

ms_load_sites(), ms_load_spatial_product(), ms_load_product()

Examples

ws_attr_vars <- ms_load_variables(var_set = 'ws_attr')

MacroSHEDS/macrosheds documentation built on Oct. 30, 2024, 11:15 a.m.