Convenience function for labelling columns in input data

This function provides an interface to easily create a 'data dictionary' so that {mqor} functions can correctly identify where observed values, modelled values, site IDs, etc. are found in an input data.frame.

Usage

mqo_dict(
  obs = "obs",
  mod = "mod",
  site = "site",
  type = "type",
  pollutant = "param",
  date = "date"
)

Arguments

obs, mod: A character string to identify the columns associated with the observed (measured) (obs) and modelled (mod) concentrations. These will be used alongside params to calculate relevant metrics.
site: A character string to identify the column to group obs and mod by when calculating statistics. This does not strictly have to be a site name; a site ID or abbreviation would suffice, as long as the labels uniquely define separate sampling points.
type: A character string to identify the column to assign sites as either "fixed" or "indicative".
pollutant: A character string to identify the column which distinguishes between different pollutant species. This column will be used to filter the data before it is calculated.
date: A character to identify a POSIXct/Date column. Only relevant for short-term data.

Value

a list of length 5, with names obs, mod, site, type, pollutant and date.