metrics.compare {amber}R Documentation

Compares global mean statistical meterics for multiple model runs

Description

This function plots statistical meterics for multiple model runs. This is useful for comparing the impact of changes in model settings or input data.

Usage

metrics.compare(mod.path.list = mod.path.list, plot.width = 13,
  plot.height = 14, outputDir = FALSE, defineVariableOrder = TRUE,
  myVariables = myVariables)

Arguments

mod.path.list

A list with paths for each model run, e.g. mod.path.list <- list(mod01.path, mod02.path, mod03.path)

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 statistical metrics for multiple model runs.

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/SIMod01', package = 'amber')
mod02.path <- system.file('extdata/SIMod02', package = 'amber')

mod.path.list <- list(mod01.path, mod02.path)
myVariables <- c('RNS', 'RSS', 'RLS', 'ALBS', 'HFLS', 'HFSS', 'HFG', 'GPP',
'RECO', 'NEE', 'FIRE', 'AGB', 'CVEG', 'CSOIL', 'LAI', 'BURNT', 'SNW', 'MRSLL', 'MRRO')

myVariables <- c('ALBS', 'GPP', 'LAI')

metrics.compare(mod.path.list = mod.path.list, plot.width = 5, plot.height = 15,
outputDir = FALSE, defineVariableOrder = TRUE, myVariables = myVariables)


[Package amber version 1.0.3 Index]