Usage
gen_hw_set(out, dataFolder, dataDirectories = list(historical = c(1980, 2004),
rcp85 = c(2006, 2099)), citycsv, coordinateFilenames, tasFilenames,
timeFilenames, IDheatwavesFunction = "IDHeatwavesCPPwrapper",
thresholdBoundaries = c(1990, 1999), projectionBoundaries = c(2070, 2079),
referenceBoundaries = c(2070, 2079), models_to_run = "all",
probThreshold = 0.98, numDays = 2, printWarning = TRUE,
threshold_ensemble = "r1i1p1", lat_lon_colnames = c("lat", "lon"),
input_metric = "kelvin")Arguments
out
Character string with pathway to directory to which
heat wave files will be written. This should be a pathname to a directory
on the user's local computer. If the directory already exists, it will
be overwritten by this function, so the user should either
dataFolder
Character string with pathway to a directory with
climate projection data. This directory must have a specific structure--
see the futureheatwaves vignette for guidance on setting up this
directory.
dataDirectories
A list object, with two elements, one for each of the
two subdirectories included in the main directory. Typically, these will
be separate directories of historical and projection experiments from
climate models. Each element of the list should be named w
citycsv
Character string giving the filepath to a
comma-separated (.csv) file with, for each study city, a unique city
identifier, latitude, and longitude. These values must be specified with
the column names city, lat, and lon
coordinateFilenames
Character string the with filename of each
grid point location file. This filename should be identical for all
ensemble member subdirectories included in the dataFolder directory.
See the package vignette for an example of the required struct
tasFilenames
Character string the with filename of each climate
projection file. This filename should be identical for all ensemble
member subdirectories included in the dataFolder directory. See the
package vignette for an example of the required structu
timeFilenames
Character string the with filename of each projection
dates file. This filename should be identical for all ensemble
member subdirectories included in the dataFolder directory. See
the package vignette for an example of the required structur
IDheatwavesFunction
A character string with the name of the R function
to use to identify heat waves. This function may be a user-specified custom
function, but it must be loaded into the current R session. The
function name must be put in quotation marks. For more guidance
thresholdBoundaries
A numeric vector with the custom time boundaries
to be used to determine the threshold temperatures for the heat wave
definition. The required format for this vector is c(start year, end
year), with the restriction that bounds must be contained within the
projectionBoundaries
A numeric vector with the custom time boundaries
for which the user wants to create heat wave projections. The required
format for this vector is c(start year, end year), with the restriction
that bounds must be contained within the time boundaries of one
referenceBoundaries
A numeric vector with the custom time boundaries
to use in calculating relative characteristics for heat waves (i.e., to use
when exploring the role of adaptation in projections). For more
information on how reference temperatures are used, see the packag
models_to_run
A character vector with either "all" (the default),
in which case the function runs through all models in the dataFolder
directory, or the names of the models to run, using the names of each
model's subdirectory within the data directory (e.g
probThreshold
Numerical value between 0 and 1 specifying the
percentile to be used for the threshold temperature used to define heat
waves. The default value is 0.98 (i.e., a heat wave is a certain number of
days above the city's 98th percentile temperature).
numDays
Integer greater than 0 giving the number of days to
use in the heat wave definition (e.g., numDays = 2 would define a
heat wave as two or more days above the threshold temperature).
printWarning
TRUE / FALSE, specifies whether to print out a warning
informing the user that the function will write out results to the local
directory specified by the user with out. This warning prints out
by default; the user must opt out of this warnin
threshold_ensemble
A character vector giving the name of the ensemble
member that should be used when determining the city-specific threshold
temperatures for each climate model (e.g., "r1i1p1"). This
threshold is used for relative heat wave definitions. See t
lat_lon_colnames
A character vector of length two with the column names
in the citycsv dataframe for latitude (first vector element) and
longitude (second vector element)
input_metric
A character string indicating the temperature metric
of the climate projection data being processed. Choices are "kelvin",
"fahrenheit", and "celsius".