Systems Insights from Generation of Hydroclimatic Timeseries

---

Documentation for package ‘foreSIGHT’ version 2.0.0

• DESCRIPTION file.
• User guides, package vignettes and other documentation.
• Package NEWS.

Help Pages

barossa_obs	Multi-site rainfall observations in the Barossa Valley used in examples and vignette
boxplot_prob	Draws a boxplot with the whiskers at specified probability limits
calculateAttributes	Calculates the attributes of the hydroclimate time series
calGR4J	Calibrate GR4J rainfall runoff model parameters
convert_climYMD_POSIXct	Converts "old" reference climate data format (<V1.2) to "new" format with POSIXct dates.
createExpSpace	Creates exposure space of hydroclimatic targets for generation of scenarios using 'generateScenarios'
create_clim	Create foreSIGHT reference climate object from time information and climate data.
data_A5030502	Catchment data for Scott Creek in South Australia for period 1976-1985.
egClimData	Climate attributes from projections.
egMultiSiteSim	Output from call to generateScenarios() using multi-site model (see example 5 in generateScenarios).
egScalPerformance	Performance metrics of the tank model using simple scaled scenarios.
egScalSummary	Summary of a simple scaled scenario.
egSimOATPerformance	Performance metrics of the tank model using OAT scenarios.
egSimOATSummary	Summary of a OAT scenario.
egSimPerformance	Performance metrics of the tank model using regGrid scenarios.
egSimPerformanceB	Performance metrics of an alternate tank model using regGrid scenarios.
egSimSummary	Summary of a regGrid scenario.
evaluate_system_metrics	Calculates system metrics for and observed and baseline stochastic climates
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 value spells
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)
func_P	Calculates a quantile value
func_R	Calculates the number of days above a threshold (often used for temperature)
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 wettest6monPeakDay
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
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-rainfall time series on dry-days
mvFunc_cvWetDay	Calculates the coefficient of variation (sdev/mean) value of a non-rainfall time series on wet-days
plotExpSpace	Plots the location of points in a two-dimensional exposure space
plotOptions	Plots the differences in performance metrics from two system options
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 as input
plotPerformanceSpaceMulti	Plots contours of the number of performance thresholds exceeded in the perturbation space
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 annual changes
shuffle_sim	Post-processing to apply changes in temporal structure of annual precipitation.
sim.stoch	Example perturbed stochastic climates for Scott Creek.
subdaily_synthetic_obs	Synthetic sub-daily rainfall data
tankPerformance	A function to calculate difference performance from simulated tank behaviour
tankWrapper	Wrapper function for a rain water tank system model
tank_obs	Observations for demo tank model examples and vignette
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 system model
writeControlFile	Writes a sample 'controlFile.json' file