formHwFrame: Create heat wave dataframe for an ensemble

Description Usage Arguments Value

View source: R/processHeatwaves.R

Description

This function takes inputs, from processProjections, on the projection data for an ensemble member, the thresholds for cities for the ensemble, and global and custom objects with user specifications. Using these inputs, the function creates a dataframe with heat waves identified and characterized for the ensemble member.

Usage

1
formHwFrame(ensembleSeries, thresholds, global, custom)

Arguments

ensembleSeries

A list object giving the projection time series as well as a variety of other information for a single ensemble member. This is the output of processEnsemble.

thresholds

A vector with the thresholds to use within each city in that city's heat wave definition.These are typically automatically determine during the run of the gen_hw_set function.

global

An list object created by gen_hw_set that includes user specifications (e.g., the path to the output directory, the path to the input climate projections, the dataframe with city locations).

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 determine threshold temperatures for the heat wave definition, alternative upper and lower year boundaries for the projection period of the heat wave datasets being generated).

Value

The combined dataframe of identified and characterized heat waves for selected projection date range for all cities specified by the user. This dataframe includes the following columns:

An example of the output of this function is available as the hw_datafr dataset and can be accessed using data(hw_datafr).


geanders/futureheatwaves documentation built on June 5, 2017, 9:05 a.m.