foreSIGHT2.0.0 package

Systems Insights from Generation of Hydroclimatic Timeseries

calGR4J

Calibrate GR4J rainfall runoff model parameters

convert_climYMD_POSIXct

Converts "old" reference climate data format (<V1.2) to "new" format w...

create_clim

Create foreSIGHT reference climate object from time information and cl...

createExpSpace

Creates exposure space of hydroclimatic targets for generation of scen...

egScottCreekSimStoch

Example perturbed stochastic climates for Scott Creek.

modSimulator

modSimulator

mvFunc_avgDryDay

Calculates the average value of a non-rainfall time series on dry-days

mvFunc_avgWetDay

Calculates the average value of a non-rainfall time series on wet-days

mvFunc_cor

Calculates the correlation between two time series

mvFunc_cvDryDay

Calculates the coefficient of variation (sdev/mean) value of a non-rai...

mvFunc_cvWetDay

Calculates the coefficient of variation (sdev/mean) value of a non-rai...

plotExpSpace

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

plotOptions

Plots the differences in performance metrics from two system options

func_rng

Calculates the inter-quantile range

func_seasRatio

Calculates seasonality ratio

func_tot

Calculates total of time series

func_WDcor

Calculates the lag-1 autocorrelation for wet days

func_wettest6monPeakDay

Calculates the day of year corresponding to the wettest 6 months

func_wettest6monSeasRatio

Calculates the ratio of wet season to dry season rainfall, based on we...

generateScenarios

Produces time series of hydroclimatic variables for an exposure space.

getSimSummary

Produces a summary object containing the metadata of a full simulation

GR4J_wrapper

System model wrapper GR4J

modCalibrator

modCalibrator

tankPerformance

A function to calculate difference performance from simulated tank beh...

func_P

Calculates a quantile value

func_R

Calculates the number of days above a threshold (often used for temper...

barossa_obs

Multi-site rainfall observations in the Barossa Valley used in example...

boxplot_prob

Draws a boxplot with the whiskers at specified probability limits

calculateAttributes

Calculates the attributes of the hydroclimate time series

evaluate_system_metrics

Calculates system metrics for and observed and baseline stochastic cli...

foreSIGHT

foreSIGHT: A package for Systems Insights from Generation of Hydroclim...

func_avg

Calculates average of time series

func_avgDSD

Calculates average dry spell duration (below threshold)

func_avgDwellTime

Calculates the average dwell time, i.e. average time for below median ...

func_avgWSD

Calculates average wet spell duration (below threshold)

func_cor

Calculates the lag-1 autocorrelation

func_cv

Calculates the coefficient of variation (mead/sd)

func_dyWet

Calculates average rainfall on wet days (above threshold)

func_F0

Calculates the number of frost days

func_maxDSD

Calculates maximum dry spell duration (below threshold)

func_maxWSD

Calculates maximum wet spell duration (above threshold)

func_normP

Calculates normalised quantile (quantile divided by mean)

func_nWet

Calculates number of wet days (above threshold)

plotPerformanceAttributesOAT

Plots changes in attributes for a specified perturbed attribute

plotPerformanceOAT

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

plotPerformanceSpace

Plots a performance space using the system performance and scenarios a...

plotPerformanceSpaceMulti

Plots contours of the number of performance thresholds exceeded in the...

plotScenarios

Creates summary plots of the biases in the scenarios

runSystemModel

Runs a system model and outputs the system performance

setSeasonalTiedAttributes

Creates tied attributes which tie seasonal changes in attributes to an...

shuffle_sim

Post-processing to apply changes in temporal structure of annual preci...

subdaily_synthetic_obs

Synthetic sub-daily rainfall data

tank_obs

Observations for demo tank model examples and vignette

tankWrapper

Wrapper function for a rain water tank system model

viewAttributeDef

Prints the definition of an attribute

viewAttributeFuncs

Prints the list of built-in attribute functions

viewDefaultOptimArgs

Prints the default optimisation arguments

viewModelParameters

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

viewModels

Prints the available stochastic model options

viewTankMetrics

Prints the names of the performance metrics of the rain water tank sys...

writeControlFile

Writes a sample controlFile.json file

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) <doi:10.1029/2012EO410001> and Prudhomme et al. (2010) <doi:10.1016/j.jhydrol.2010.06.043>). 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) <doi:10.1002/2015WR018253>) and stochastic simulation of perturbed time series via an inverse approach (see Guo et al. (2018) <doi:10.1016/j.jhydrol.2016.03.025>). It incorporates 'Richardson-type' weather generator model configurations documented in Richardson (1981) <doi:10.1029/WR017i001p00182>, Richardson and Wright (1984), as well as latent variable type model configurations documented in Bennett et al. (2018) <doi:10.1016/j.jhydrol.2016.12.043>, Rasmussen (2013) <doi:10.1002/wrcr.20164>, Bennett et al. (2019) <doi:10.5194/hess-23-4783-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) <doi:10.1016/j.envsoft.2021.104999>. As further developments in scenario-neutral approaches occur the tool will be updated to incorporate these advances.

  • Maintainer: David McInerney
  • License: GPL-3
  • Last published: 2025-09-14