# Assessing Skill of Climate Forecasts on Seasonal-to-Decadal Timescales

## Documentation for package ‘CSTools’ version 5.3.0

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

## Help Pages

AdamontAnalog | CST_AdamontAnalog finds analogous data in the reference dataset to experiment data based on weather types
AdamontQQCorr | AdamontQQCorr computes quantile-quantile correction of seasonal or decadal forecast data using weather types
Analogs | Analogs based on large scale fields.
AreaWeighted | Calculate the spatial area-weighted average of multidimensional arrays.
as.s2dv_cube | Conversion of 'startR_array' or 'list' objects to 's2dv_cube'
BEI_EMWeighting | Computing the weighted ensemble means for SFSs.
BEI_PDFBest | Computing the Best Index PDFs combining Index PDFs from two SFSs
BEI_ProbsWeighting | Computing the weighted tercile probabilities for SFSs.
BEI_TercilesWeighting | Computing the weighted terciles for SFSs.
BEI_Weights | Computing the weights for SFSs using the Best Index PDFs.
BiasCorrection | Bias Correction based on the mean and standard deviation adjustment
BindDim | Bind two arrays by a specified named dimension
Calibration | Forecast Calibration
CategoricalEnsCombination | Make categorical forecast based on a multi-model forecast with potential for calibrate
CST_AdamontAnalog | CST_AdamontAnalog finds analogous data in the reference dataset to experiment data based on weather types
CST_AdamontQQCorr | CST_AdamontQQCorr computes quantile-quantile correction of seasonal or decadal forecast data using weather types
CST_Analogs | Downscaling using Analogs based on large scale fields.
CST_AnalogsPredictors | AEMET Downscaling Precipitation and maximum and minimum temperature downscaling method based on analogs: synoptic situations and significant predictors.
CST_Anomaly | Anomalies relative to a climatology along selected dimension with or without cross-validation
CST_AreaWeighted | Calculate the spatial area-weighted average of multidimensional arrays.
CST_BEI_Weighting | Weighting SFSs of a CSTools object.
CST_BiasCorrection | Bias Correction based on the mean and standard deviation adjustment
CST_BindDim | Bind two objects of class s2dv_cube
CST_Calibration | Forecast Calibration
CST_CategoricalEnsCombination | Make categorical forecast based on a multi-model forecast with potential for calibrate
CST_ChangeDimNames | Change the name of one or more dimensions for an object of class s2dv_cube
CST_DynBiasCorrection | Performing a Bias Correction conditioned by the dynamical properties of the data.
CST_EnsClustering | Ensemble clustering
CST_InsertDim | Add a named dimension to an object of class s2dv_cube
CST_Load | CSTools Data Retreival Function
CST_MergeDims | Function to Merge Dimensions
CST_MultiEOF | EOF analysis of multiple variables
CST_MultiMetric | Multiple Metrics applied in Multiple Model Anomalies
CST_MultivarRMSE | Multivariate Root Mean Square Error (RMSE)
CST_ProxiesAttractor | Computing two dinamical proxies of the attractor in s2dv_cube.
CST_QuantileMapping | Quantile Mapping for seasonal or decadal forecast data
CST_RainFARM | RainFARM stochastic precipitation downscaling of a CSTools object
CST_RegimesAssign | Function for matching a field of anomalies with a set of maps used as a reference (e.g. clusters obtained from the WeatherRegime function)
CST_RFSlope | RainFARM spectral slopes from a CSTools object
CST_RFTemp | Temperature downscaling of a CSTools object using lapse rate correction or a reference field
CST_RFWeights | Compute climatological weights for RainFARM stochastic precipitation downscaling
CST_SaveExp | Save objects of class 's2dv_cube' to data in NetCDF format
CST_SplitDim | Function to Split Dimension
CST_Start | CSTools data retrieval function using Start
CST_Subset | Subset an object of class s2dv_cube
CST_Summary | Generate a Summary of the data and metadata in the s2dv_cube object
CST_WeatherRegimes | Function for Calculating the Cluster analysis
DynBiasCorrection | Performing a Bias Correction conditioned by the dynamical properties of the data.
EnsClustering | Ensemble clustering
EvalTrainIndices | Generate Training and Evaluation Indices for Cross-Validation
lonlat_prec | Sample Of Experimental Precipitation Data In Function Of Longitudes And Latitudes
lonlat_prec_st | Sample Of Experimental Precipitation Data In Function Of Longitudes And Latitudes with Start
lonlat_temp | Sample Of Experimental And Observational Climate Data In Function Of Longitudes And Latitudes
lonlat_temp_st | Sample Of Experimental And Observational Climate Data In Function Of Longitudes And Latitudes with Start
MergeDims | Function to Split Dimension
MultiEOF | EOF analysis of multiple variables starting from an array (reduced version)
MultiMetric | Multiple Metrics applied in Multiple Model Anomalies
PDFIndexHind | Computing the Index PDFs for a dataset of SFSs for a hindcats period.
PlotCombinedMap | Plot Multiple Lon-Lat Variables In a Single Map According to a Decision Function
PlotForecastPDF | Plot one or multiple ensemble forecast pdfs for the same event
PlotMostLikelyQuantileMap | Plot Maps of Most Likely Quantiles
PlotPDFsOLE | Plotting two probability density gaussian functions and the optimal linear estimation (OLE) as result of combining them.
PlotTriangles4Categories | Function to convert any 3-d numerical array to a grid of coloured triangles.
PlotWeeklyClim | Plots the observed weekly means and climatology of a timeseries data
Predictability | Computing scores of predictability using two dynamical proxies based on dynamical systems theory.
print.s2dv_cube | Print method for s2dv_cube objects
ProxiesAttractor | Computing two dinamical proxies of the attractor.
QuantileMapping | Quantile Mapping for seasonal or decadal forecast data
RainFARM | RainFARM stochastic precipitation downscaling (reduced version)
RegimesAssign | Function for matching a field of anomalies with a set of maps used as a reference (e.g. clusters obtained from the WeatherRegime function).
RFSlope | RainFARM spectral slopes from an array (reduced version)
RFTemp | Temperature downscaling of a CSTools object using lapse rate correction (reduced version)
RF_Weights | Compute climatological weights for RainFARM stochastic precipitation downscaling
s2dv_cube | Creation of a 's2dv_cube' object
SaveExp | Save a multidimensional array with metadata to data in NetCDF format
SplitDim | Function to Split Dimension
training_analogs | AEMET Training Training method (pre-downscaling) based on analogs: synoptic situations and significant predictors.
WeatherRegime | Function for Calculating the Cluster analysis