msdMain {msdrought} | R Documentation |
Mid Summer Drought Function
Description
Generates all relevant statistics for the Mid Summer Drought by running the msdStats function for every applicable metric. The output of msdMain is a dataframe containing every msdStats output for the available years of data.
Usage
msdMain(x, peakwindow1, minwindow1,
minwindow2, peakwindow2, quantity,
window, timeVector)
Arguments
x |
xts or vector of data |
peakwindow1 |
desired date in MMDD format to begin analysis (window 1) |
minwindow1 |
desired date in MMDD format to end analysis (window 1) |
minwindow2 |
desired date in MMDD format to begin analysis (window 2) |
peakwindow2 |
desired date in MMDD format to end analysis (window 2) |
quantity |
amount of times the filter is run |
window |
size of filter |
timeVector |
vector of dates (not needed for xts inputs) |
Value
Data frame of all relevant MSD Statistics
Examples
data("timeseries")
ts <- timeseries
df <- msdrought::msdMain(ts)
[Package msdrought version 0.1.0 Index]