Learn R Programming

foreSIGHT (version 1.2.0)

Systems Insights from Generation of Hydroclimatic Timeseries

Description

A tool to create hydroclimate scenarios, stress test systems and visualize system performance in scenario-neutral climate change impact assessments. Scenario-neutral approaches 'stress-test' the performance of a modelled system by applying a wide range of plausible hydroclimate conditions (see Brown & Wilby (2012) and Prudhomme et al. (2010) ). These approaches allow the identification of hydroclimatic variables that affect the vulnerability of a system to hydroclimate variation and change. This tool enables the generation of perturbed time series using a range of approaches including simple scaling of observed time series (e.g. Culley et al. (2016) ) and stochastic simulation of perturbed time series via an inverse approach (see Guo et al. (2018) ). It incorporates 'Richardson-type' weather generator model configurations documented in Richardson (1981) , Richardson and Wright (1984), as well as latent variable type model configurations documented in Bennett et al. (2018) , Rasmussen (2013) , Bennett et al. (2019) to generate hydroclimate variables on a daily basis (e.g. precipitation, temperature, potential evapotranspiration) and allows a variety of different hydroclimate variable properties, herein called attributes, to be perturbed. Options are included for the easy integration of existing system models both internally in R and externally for seamless 'stress-testing'. A suite of visualization options for the results of a scenario-neutral analysis (e.g. plotting performance spaces and overlaying climate projection information) are also included. Version 1.0 of this package is described in Bennett et al. (2021) . As further developments in scenario-neutral approaches occur the tool will be updated to incorporate these advances.

Copy Link

Version

Install

install.packages('foreSIGHT')

Monthly Downloads

284

Version

1.2.0

License

GPL-3

Maintainer

David McInerney

Last Published

October 19th, 2023

Functions in foreSIGHT (1.2.0)

func_tot

Calculates total of time series
func_rng

Calculates the inter-quantile range
generateScenarios

Produces time series of hydroclimatic variables for an exposure space.
getSimSummary

Produces a summary object containing the metadata of a full simulation
func_avgDSD

Calculates average dry spell duration (below threshold)
func_wettest6monSeasRatio

Calculates the ratio of wet season to dry season rainfall, based on wettest6monPeakDay
runSystemModel

Runs a system model and outputs the system performance
egSimSummary

Summary of a regGrid scenario.
generateScenario

Produces time series of hydroclimatic variables for an exposure target.
func_seasRatio

Calculates seasonality ratio
func_avgWSD

Calculates average wet spell duration (below threshold)
func_wettest6monPeakDay

Calculates the day of year corresponding to the wettest 6 months
viewDefaultOptimArgs

Prints the default optimisation arguments
viewAttributeFuncs

Prints the list of built-in attribute functions
plotScenarios

Creates summary plots of the biases in the scenarios
tankPerformance

A function to calculate difference performance from simulated tank behaviour
foreSIGHT

foreSIGHT: A package for Systems Insights from Generation of Hydroclimatic Timeseries
plotExpSpace

Plots the location of points in a two-dimensional exposure space
plotMultiSiteScenarios

Creates summary plots of the biases in the multi-site scenarios
tankWrapper

Wrapper function for a rain water tank system model
viewModelParameters

Prints the names and bounds of the parameters of the stochastic models
viewModels

Prints the available stochastic model options
func_F0

Calculates the number of frost days
func_maxWSD

Calculates maximum wet spell duration (above threshold)
func_CSL

Calculates the cold season length
func_nWet

Calculates number of wet days (above threshold)
tank_obs

Observations for demo tank model examples and vignette
modCalibrator

modCalibrator
modSimulator

modSimulator
func_dyWet

Calculates average rainfall on wet days (above threshold)
viewAttributeDef

Prints the definition of an attribute
viewVariables

Prints the names of and units of valid variables
viewTankMetrics

Prints the names of the performance metrics of the rain water tank system model
func_maxDSD

Calculates maximum dry spell duration (below threshold)
plotOptions

Plots the differences in performance metrics from two system options
plotPerformanceOAT

Plots performance for one-at-a-time (OAT) perturbations in attributes
plotPerformanceSpaceMulti

Plots contours of the number of performance thresholds exceeded in the perturbation space
writeControlFile

Writes a sample controlFile.json file
plotPerformanceSpace

Plots a performance space using the system performance and scenarios as input
calculateAttributes

Calculates the attributes of the hydroclimate time series
climdata

Example climate projection data
barossa_obs

Multi-site rainfall observations in the Barossa Valley used in examples and vignette
createExpSpace

Creates exposure space of hydroclimatic targets for generation of scenarios using 'generateScenarios'
egMultiSiteSim

Output from call to generateScenarios() using multi-site model (see example 5 in generateScenarios).
func_R

Calculates the number of days above a threshold (often used for temperature)
func_avg

Calculates average of time series
func_P

Calculates a quantile value
egClimData

Climate attributes from projections.
func_GSL

Calculates the growing season length
egScalSummary

Summary of a simple scaled scenario.
egSimPerformance

Performance metrics of the tank model using regGrid scenarios.
egSimOATPerformance

Performance metrics of the tank model using OAT scenarios.
egScalPerformance

Performance metrics of the tank model using simple scaled scenarios.
egSimOATSummary

Summary of a OAT scenario.
egSimPerformance_systemB

Performance metrics of an alternate tank model using regGrid scenarios.