scores.compare {amber}R Documentation

Compares scores from two model runs

Description

This function compares scores from two different model runs.

Usage

scores.compare(mod01.path, mod02.path, mod01.id, mod02.id,
  score.weights = c(1, 2, 1, 1, 1), plot.width = 7.3,
  plot.height = 5, outputDir = FALSE, defineVariableOrder = FALSE,
  myVariables = myVariables)

Arguments

mod01.path

A string that gives the path where the output from scores.tables is stored (model 1)

mod02.path

A string that gives the path where the output from scores.tables is stored (model 2)

mod01.id

A string that gives the name of a model, e.g. 'CanESM2'

mod02.id

A string that gives the name of a model, e.g. 'CanESM5'

score.weights

R object that gives the weights of each score (S_{bias}, S_{rmse}, S_{phase}, S_{iav}, S_{dist}) that are used for computing the overall score, e.g. c(1,2,1,1,1)

plot.width

Number that gives the plot width, e.g. 6

plot.height

Number that gives the plot height, e.g. 5

outputDir

A string that gives the output directory, e.g. '/home/project/study'. The output will only be written if the user specifies an output directory.

defineVariableOrder

Logical. If TRUE, variables are sorted according to the parameter myVariables defined below. Default setting is FALSE.

myVariables

An R object with variable names of variables that should be included in table, e.g. c('GPP', 'RECO', 'NEE')

Value

A figure in PDF format that shows the (a) skill score and (b) skill score difference when compared against a different model run. White numbers indicate that score differences are not statistically significant at the 5 percent level using the two-sided Wilcox significance test.

Examples

library(amber)
library(classInt)
library(doParallel)
library(foreach)
library(Hmisc)
library(latex2exp)
library(ncdf4)
library(parallel)
library(raster)
library(rgdal)
library(rgeos)
library(scico)
library(sp)
library(stats)
library(utils)
library(viridis)
library(xtable)

mod01.path <- system.file('extdata/model01', package = 'amber')
mod02.path <- system.file('extdata/model02', package = 'amber')
mod01.id <- 'Model01'
mod02.id <- 'Model02'
score.weights <- c(1,2,1,1,1)
scores.compare(mod01.path, mod02.path, mod01.id, mod02.id,  score.weights)


[Package amber version 1.0.3 Index]