futureheatwaves (version 1.0.3)

apply_all_models: Apply a function across heat waves from all projections

Description

This function will take a user-specified function and apply it across all the extreme event files created by gen_hw_set. It will generate either a single value for every ensemble member within every climate model, if city_specific is set to FALSE, or a value for every city for every ensemble member, if city_specific is set to TRUE.

Usage

apply_all_models(out, FUN, city_specific = FALSE, ...)

Arguments

out

Character string with pathname to which extreme event files were written by gen_hw_set. Typically, this will be the same pathname as that specified with out when running gen_hw_set.

FUN

A character string with the name of a function to apply to the extreme event dataframes located in the directory specified by out. This function must take the argument, hw_datafr, a dataframe of identified and characterized extreme events, as generated by gen_hw_set. For an example of one of these dataframes, load the hw_datafr data. The function should output a single value when applied to the full extreme event dataframe. The function can also have other arguments, which are passed through the ... argument of apply_all_models.

city_specific

TRUE or FALSE, specifying whether the function should be applied separately for each study location.

...

Optional arguments to FUN.

Value

A dataframe with the value output by the FUN function, as applied to all the extreme event dataframes generated by gen_hw_set.

Examples

ex_results <- system.file("extdata/example_results",
                          package = "futureheatwaves")
apply_all_models(ex_results, FUN = average_mean_temp)
apply_all_models(ex_results, FUN = average_mean_temp,
                 city_specific = TRUE)