Learn R Programming

futureheatwaves (version 1.0.0)

getBounds: Acquire boundaries of time series data

Description

This function acquires the boundaries of time series data.

Usage

getBounds(times, custom, type)

Arguments

times
A dataframe containing the time data for one ensemble member's projections. Each row in this dataframe corresponds to the row with the same row number in the climate projection dataframe.
custom
An list object created by gen_hw_set that includes user specifications (e.g., the name of the R function to use to identify heat waves, alternative upper and lower year boundaries for the data used to de
type
A character vector giving the type of boundaries that are being checked. Possible values are "threshold", "projections", and "reference".

Value

  • A numeric vector containing the number of days spanned by the time period, the lower bound of the experiment time period as an index specifying the relevant row of the climate projection data; and an upper bound of the experiment time period as an index specifying the relevant row of the climate projection data.