sac_year_type_get: Get Sacramento Year Type Index Data

View source: R/sac_year_type_get.R

sac_year_type_getR Documentation

Get Sacramento Year Type Index Data

Description

sac_year_type_get() gets the historical record of Sacramento Year Type indexes, which are required input to CRSS. The function will download them from http://cdec.water.ca.gov/cgi-progs/iodir/WSIHIST and then parse the required information. If an internet connection is not available, then the internal data can be used, but it may not be up-to-date. Additionally, the index can be obtained from paleo data. For the paleo data, the index is created from the Sacramento Valley 4 river index volume as reconstructed in Meko et al. (2018). The WY volume is passed to sac_year_type_calc() to compute the index value.

Usage

sac_year_type_get(internal = FALSE, paleo = FALSE)

Arguments

internal

Boolean. If TRUE, will use the internal data saved with the package instead of downloading the data.

paleo

Boolean. If TRUE, then ignore internal and get the index from paleo data.

Details

The "crssio.sac_yt_url" option determines where the function downloads the data from.

Value

xts object with 1 column.


BoulderCodeHub/CRSSIO documentation built on July 2, 2023, 5:15 p.m.