Learn R Programming

futureheatwaves (version 1.0.0)

acquireDirectoryStructure: Acquire structure of input directory

Description

This function parses the structure of the user-provided directory of climate projection files to create a list of the climate models and ensemble members included.

Usage

acquireDirectoryStructure(dataFolder, coordinateFilenames, tasFilenames,
  timeFilenames, models_to_run, dataDirectories, threshold_ensemble,
  thresholdBoundaries)

Arguments

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.
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
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
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
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
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

Value

  • The function returns a list object outlining the file structure of the dataFolder directory.