summary_plot: summary plot

In jobonaf/dartle: Air Quality Model Benchmarking

Description

summary_report: prepare input

Usage

summary_report(data, obs, mod, point, pollutant = c("NO2", "O3", "PM10",
  "PM2.5"), beta = 2)

summary_plot(s_rep, title = NULL)

Arguments

data	a data frame including observations and model forecasts
obs	name of the column with observed data
mod	name of the column with forecasts
point	name of the column with station ID
pollutant	one of "NO2", "O3", "PM10", "PM2.5"
beta	parameter β (default is 2)
s_rep	output of summary_report
title	main title for the plot (if NULL, is build as paste("Summary statistics",s_rep$parameters$pollutant))

Value

summary_report returns a list of 3:

summary_points

a data frame with 8 variables for each station

Point

station ID

Obs.ave

annual mean of observations (paired with forecasts)

Mod.ave

annual mean of forecasts (paired with observations)

mpi_bias

Model Performance Indicator for the bias (see MPI_bias)

mpi_corr_time

Model Performance Indicator for the correlation in time (see MPI_corr_time)

mpi_sdev_time

Model Performance Indicator for the standard deviation in time (see MPI_sdev_time)

mpi_perc

Model Performance Indicator for high percentile values (see MPI_perc)

n_valid

no. of valid data

summary_overall

a data frame with 3 overall indicators

mpi_corr_space

Model Performance Indicator for the correlation in space (see MPI_corr_space)

mpi_sdev_space

Model Performance Indicator for the standard deviation in space (see MPI_sdev_space)

n_points

no. of valid stations

parameters

a list of 7 parameters

U_RV95r

see params_U

alpha

see params_U

RV

see params_U

Np

see params_U

Nnp

see params_U

pollutant

same as in input, one of "NO2", "O3", "PM10", "PM2.5"

beta

same as in input

References

Janssen et al., 2017. "Guidance Document on Modelling Quality Objectives and Benchmarking. Version 2.1"

Examples

# prepare dataset
require(dplyr)
Mod <- dMean(mod.data %>% filter(Var=="c_PM10"),
             value = "Value", time = "Time", point = "Point")
Obs <- obs.pm10 %>% mutate(Day=format(Time,"%Y-%m-%d"),
                           Point=ID)
Dat <- inner_join(Mod, Obs, by=c("Point", "Day"), suffix = c(".mod", ".obs"))

# calculate indicators
s_rep <- summary_report(Dat, obs = "Value.obs", mod = "Value.mod",
                       point = "Point", pollutant = "PM10")

# plot
summary_plot(s_rep)

jobonaf/dartle documentation built on May 29, 2019, 4:52 p.m.