# Systems Insights from Generation of Hydroclimatic Timeseries

## Documentation for package ‘foreSIGHT’ version 1.1.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

barossa_obs | Multi-site rainfall observations in the Barossa Valley used in examples and vignette
calculateAttributes | Calculates the attributes of the hydroclimate time series
calc_meanClimDaily_dayOfYearWindow | Calculates the seasonal pattern (i.e. climatological mean)
climdata | Example climate projection data
createExpSpace | Creates exposure space of hydroclimatic targets for generation of scenarios using 'generateScenarios'
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.
egSimPerformance_systemB | Performance metrics of an alternate tank model using regGrid scenarios.
egSimSummary | Summary of a regGrid scenario.
foreSIGHT | foreSIGHT: A package for XXX
func_avg | Calculates average of time series
func_avgDSD | Calculates average dry spell duration (below threshold)
func_avgWSD | Calculates average wet spell duration (below threshold)
func_CSL | Calculates the cold season length
func_dyWet | Calculates average rainfall on wet days (above threshold)
func_F0 | Calculates the number of frost days
func_GSL | Calculates the growing season length
func_maxDSD | Calculates maximum dry spell duration (below threshold)
func_maxWSD | Calculates maximum wet spell duration (above threshold)
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_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
generateScenario | Produces time series of hydroclimatic variables for an exposure target.
generateScenarios | Produces time series of hydroclimatic variables for an exposure space.
getSimSummary | Produces a summary object containing the metadata of a full simulation
modCalibrator | modCalibrator
modSimulator | modSimulator
plotExpSpace | Plots the location of points in a two-dimensional exposure space
plotMultiSiteScenarios | Creates summary plots of the biases in the multi-site scenarios
plotOptions | Plots the differences in performance metrics from two system options
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
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
viewVariables | Prints the names of and units of valid variables
writeControlFile | Writes a sample 'controlFile.json' file