SailoR (version 1.2)

SailoR.Indices: Calculation of indices for Sailor Diagram

Description

This function returns a data frame with all the statistics used by the Sailor diagram for the set of different models in data frame mod with the reference in data frame ref.

Usage

SailoR.Indices(ref, mod, Ensembles = FALSE)

Arguments

ref

A data frame with the reference observations. It should have 3 columns: name, zonal component and meridional component.

mod

A data frame with the model data. It should have 3 columns: name, zonal component and meridional component. More than one model can be included under different names. Additionally, nrows(mod) must be an integer multiple of nrows(ref).

Ensembles

If Ensembles is set to TRUE, M different models included in the data frame mod will be taken as a single model and the reference model is repeated M times for the calculation of the Sailor diagram.

Value

The result is a data frame with a summary of the statistics obtained:

meanU

mean of the U dataset.

meanV

mean of the V dataset.

RMSE

root mean square error between U and V.

sdUx

standard deviation of zonal component (U).

sdUy

standard deviation of meridional component (U).

sdVx

standard deviation of zonal component (V).

sdVy

standard deviation of meridional component (V).

Eu

EOF matrix for the U dataset.

Ev

EOF matrix for the V dataset.

Sigmau

matrix with standard deviations of U (2x2 matrix).

Sigmav

matrix with standard deviations of V (2x2 matrix).

TotVarU

total variance of the U dataset.

TotVarV

total variance of the V dataset.

thetau

angle of EOF1 (U) with zonal axis.

thetav

angle of EOF1 (V) with meridional axis.

thetavu

rotation angle from U EOFs to V EOFs.

R2vec

vector correlation squared in 2D as defined by Breaker, Gemmill and Crossby (1994).

Rvu

rotation matrix to express Ev as a rotation from Eu.

EccentricityU

eccentricity of the ellipses from the reference dataset.

EccentricityV

eccentricity of the ellipses from the model dataset.

congruenceEOF

congruence coefficients (absolute value) for EOFs.

References

L. C. Breaker, W. H. Gemmill and D. S. Crosby (1994). The application of a technique for vector correlation to problems in meteorology and oceanography. Journal of Applied Meteorology, 33(11), 1354-1365.

Examples

# NOT RUN {
#--------------------------------------------------------
# Example 1
#--------------------------------------------------------

# Load the ocean current data 
data("Current")
  
# Calculate the indices
ref<-Current[["ref"]]
mod<-Current[["mod"]]

SailoR.Indices(ref, mod)
  
# }