observeSolute: observeSolute - instantaneous loads or concentrations

In USGS-R/loadflex: Models and Tools for Watershed Flux Estimates

observeSolute - instantaneous loads or concentrations

Description

Calculates observed instantaneous loading rates or concentrations from observed concentrations, flows, and/or fluxes, with units conversions according to the supplied metadata.

Usage

observeSolute(data, flux.or.conc = c("flux", "conc"), metadata,
  calculate = isTRUE(flux.or.conc == "flux"), attach.units = FALSE)

Arguments

data	data.frame containing, at a minimum, the columns named by metadata@constituent and metadata@flow
flux.or.conc	character giving the desired output format
metadata	An object of class "metadata" describing the units of flow (flow.units) and concentration (conc.units) of the input data, and the desired units of load (load.rate.units) for the output data
calculate	logical. If FALSE, looks for a column containing the output of interest. If true, uses the other two columns (out of those for conc, flow, and flux) to calculate the output of interest.
attach.units	logical. If TRUE, the converted observations are returned with units attached.

Examples

data(eg_metadata)
obs <- data.frame(MyConc=(1:10)/10, MyFlow=rep(10,10), MyFlux=2) # intentionally inconsistent
md <- updateMetadata(eg_metadata, constituent="MyConc", flow="MyFlow", 
  load.rate="MyFlux", dates="none", flow.units="cms", conc.units="mg/l", 
  load.units="g", load.rate.units="g/s", custom=NULL)

observeSolute(obs, "flux", md, attach.units=TRUE) # calculate from conc & flow
observeSolute(obs, "flux", md, calculate=FALSE, attach.units=TRUE) # read flux from data
observeSolute(obs, "conc", md, calculate=TRUE, attach.units=TRUE) # calculate from flow & flux
observeSolute(obs, "conc", md, calculate=FALSE, attach.units=TRUE) # read conc from data

USGS-R/loadflex documentation built on July 26, 2023, 9:54 p.m.