# Find, Characterize, and Explore Heat Waves in Climate Projections

## Documentation for package ‘futureheatwaves’ version 1.0.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

futureheatwaves-package | Find, Characterize, and Explore Heat Waves in Climate Projections
acquireDirectoryStructure | Acquire structure of input directory
apply_all_models | Apply a function across heat waves from all projections
apply_hw_projections | Apply a function to projected heat waves
average_length | Calculate average length of heat waves
average_mean_temp | Calculate average temperature of heat waves
buildStructureEnsembles | List files for a single ensemble member
buildStructureExperiments | Generate file structure for an experiment
buildStructureModels | Generate list of file structure
checkCustomBounds | Check year boundaries for errors
check_params | Check for input parameter errors
closest_point | Find closest grid point to a city location
consolidate | Consolidate heat wave dataframes
createAccumulators | Create accumulator closure
createCityProcessor | Create closure to identify and aggregate heat waves
createEnsembleWriter | Ensemble writer factory function
createHwDataframe | Characterize heat waves
datafr | Example data to input to heat wave identifier functions
formDates | Create date vector for requested time period
formHwFrame | Create heat wave dataframe for an ensemble
futureheatwaves | Find, Characterize, and Explore Heat Waves in Climate Projections
gen_hw_set | Create and write heat wave projections
getBounds | Acquire boundaries of time series data
heatwave_days | Calculate total heat wave days
hw_datafr | Example of heat wave characteristics dataset
IDheatwaves | Identify all heat waves in a time series
IDHeatwavesAlternative | Identify heat waves in a time series
IDHeatwavesCPP | Identify heat waves that are a certain number of days long
IDHeatwavesCPPwrapper | Identify heat waves in a time series
IDHeatwavesR | Identify heat waves in a time series
map_grid | Create a map of model grid
number_of_heatwaves | Calculate number of heat waves
processEnsemble | Extract projections from ensemble member
processModel | Process valid models
processProjections | Create heat wave dataframe for climate projection
processReference | Get projection data for reference period
processThresholds | Calculate threshold temperatures
process_cities_file | Process city file
readLatLong | Read latitude and longitude data
readtas | Read climate projection data
readTimes | Read projection dates data
storeHeatwaveEntry | Helper function that adds entries
storeZeroes | Helper function that adds zeroes
writeAccumulators | Write model information to file