Learn R Programming

amber (version 1.0.3)

Automated Model Benchmarking R Package

Description

Functions that quantify how well the Canadian Land Surface Scheme Including Biogeochemical Cycles (CLASSIC) reproduces land surface processes when compared against reference data. To summarize model performance across different statistical metrics, this package employs a skill score system that was originally developed by Collier et. al., (2018) .

Copy Link

Version

Install

install.packages('amber')

Monthly Downloads

13

Version

1.0.3

License

GPL-3

Maintainer

Christian Seiler

Last Published

August 28th, 2020

Functions in amber (1.0.3)

intFun.bin

Make bins
globalSumsTable

Table of globally summed values and corresponding biases.
correlationMatrixDiff

amber-package

Overview of AMBER functions
correlationMatrixFluxnet

Correlation matrix for statistical metrics computed by AMBER for FLUXNET data
correlationMatrix

Correlation matrix for statistical metrics computed by AMBER
intFun.coast

Reproject coastline
intFun.anom.mly

Monthly anomalies
intFun.anom

Anomalies
intFun.addBWtext

Add text to raster
intFun.crmse

Centralized root mean square error (CRMSE)
intFun.min.max.int

Range and interval for color bar legend
intFun.grid.define.outlier

Upper and lower threshold values that define outliers
intFun.min.max.int.bias

Range and interval for color bar legend (bias)
metrics.compare

Compares global mean statistical meterics for multiple model runs
intFun.sampleGridTime

Random sampling of gridded reference data along time axis
plotFluxnetStats

Plots that show statistical metrics for FLUXNET sites
plotEnsembleMean

Ensemble mean plots of AMBER results (bias, bias scores, etc)
intFun.sampleDataFrame

random sampling across space and time for a data frame (FLUXNET and runoff).
intFun.theta

Time distance in months
intFun.rel.error

Relative error used for binned data
intFun.rmse

Root mean square error (RMSE)
intFun.iav

Inter-annual variability
intFun.isRaster

Reproject coastline
intFun.grid.outliers.points

Convert outliers to spatial points
seasonalCycleIrreg

Zonal mean plots of model and reference data on an irregular grid
zonalMean

Zonal mean plots of model and reference data
intFun.grid.na

Replace NA with zero in raster object
plotHovmoeller

Plot Hovmoeller diagrams that show monthly climatological mean values and biases
scores.tables

Summarize results in a table and a plot
plotZonalMeans

Plot zonal mean values of model and reference data in a single figure
scores.site.notime

Scores for site-level reference data that do not vary in time
plotZonalMeanStats

Plot zonal mean plots of AMBER results (bias, bias scores, etc)
plotGrid

Plots raster layers of a raster stack object
intFun.min.max.int.raw

Range and interval for color bar legend
intFun.grid.outliers.na

Set all values outside a range to NA
intFun.min.max.int.mod.ref

Range and interval for color bar legend for two raster objects
intFun.sampleGridTimeAndSpace

random sampling across space and time (if available) for reference grid data
plotBars

Barplots of reference and model data with same unit
intFun.grid.significance

Set significant differences to NA
intFun.grid.phase

Time distance in months
scores.fluxnet.nc

Scores for FLUXNET reference data in NetCDF format
plotEnsembleHovmoeller

Hovmoeller Diagram for model ensemble
scores.fluxnet.site

Scores for FLUXNET reference data when model run at FLUXNET site
intFun.site.points

Make spatial points
scores.compare.ensemble

Summarize scores from multiple model runs in single figure.
intFun.min.max.int.diff

Range and interval for color bar legend (difference)
intFun.grid.wilcox

Wilcox significance test
intFun.min.max.int.ext

Range and interval for color bar legend
scores.compare

Compares scores from two model runs
scores.compare.benchmarks

Compares model scores against scores reference scores.
plotNc

Plots the time-mean of a variable stored in NetCDF model output on a regular grid
scores.fluxnet.csv

Scores for FLUXNET reference data in CSV format
seasonalCycle

Zonal mean plots of model and reference data
scores.tables.tweak

Tweak summary table
scores.grid.time

Scores for gridded reference data with a varying time dimension
zonalMeanStats

Zonal mean plots of AMBER results (bias, bias scores, etc)
zonalMeanIrreg

Zonal mean plots of model and reference data on an irregular grid
scores.runoff

Scores for runoff
scores.functional.response

Response of a variable to its forcing
plotNcIrreg

Plots the time-mean of a variable stored in NetCDF model output on an irregular grid
scores.grid.notime

Scores for gridded reference data that do not have a varying time dimension