Skip to contents

All functions

aggregateSolute()
Aggregate loads by the time periods specified by the user
as.data.frame(<metadata>)
Convert a metadata object to a 1-row data.frame
compModel-class
#### compModel class #### The engine of a loadInterp model.
convertToEGRET()
Convert loadflex to EGRET object
convertToEGRETDaily()
Convert estimation and load prediction data into the EGRET Daily data.frame
convertToEGRETInfo()
Convert a loadflex metadata object into the EGRET INFO dataframe.
convertToEGRETSample()
Convert the interpolation data.frame into the EGRET Sample dataframe.
convertUnits()
Produce conversion factor to multiply old.units by to get new.units
rhoEqualDates() rho1DayBand()
Get the assumed correlation between residuals or predictions at pairs of dates.
cormatEqualDates() cormat1DayBand() cormatDiagonal()
Functions that each produce an autocorrelation matrix with a specified pattern.
correlations
Correlation functions in loadflex
dimInfo()
Return a data.frame describing each dimension of the units (1 row per dimension)
eg_loadflex lamprey_discharge lamprey_nitrate eg_fitdat eg_estdat eg_metadata eg_loadInterp eg_loadLm eg_loadReg2 eg_loadComp
Example datasets and objects for the loadflex package
`==`(<metadata>,<metadata>)
Basic equality test for two metadata objects.
estimateMSE()
Estimate model uncertainty algorithmically.
estimateMSE(<loadComp>)
Estimate uncertainty in a composite model.
estimateMSE(<loadInterp>)
Estimate uncertainty in an interpolation using leave-one-out cross validation.
estimateRho()
Estimate the autocorrelation of a mid- to high-resolution time series
expandFlowForEGRET()
Convert a date and discharge data.frame into EGRET format
flowconcToFluxConversion()
Provide the conversion factor which, when multiplied by flow * conc, gives the flux in the desired units
formatPreds()
formatPreds raw to final predictions
genericDistanceWeightedInterpolation()
A parameterizable distance-weighted interpolation function.
genericSmoothSplineInterpolation()
A parameterizable smoothing spline function.
genericTriangularInterpolation()
A parameterizable triangular interpolation function.
getCormatCustom()
Turn an autocorrelation function into a function that produces a correlation matrix
getCormatFirstOrder()
get rho matrix first order
getCormatTaoBand()
Same idea as getCormatCustom(rho1DayBand, dates) but runs faster.
getCorrectionFraction()
The fraction of prediction that is due to a correction.
getDistanceWeightedInterpolation()
Generate a distance-weighted interpolation function with the parameters of your choice.
getFittedModel()
Retrieve the fitted model, if appropriate, from a loadModel load model
getFittedModel(<loadModel>)
Retrieve the fitted model, if appropriate, from a loadModel load model
getFittingData()
Extract the data originally used to fit a load model.
getFittingData(<loadModel>)
Retrieve the data used to fit the model
getFittingFunction()
Get a function that can be used to refit the load.model with new data.
getFittingFunction(<loadModel>)
Retrieve a fitting function from a loadModel load model
getMetadata()
Extract metadata from a load model.
getMetadata(<loadModel>)
Retrieve metadata from a loadModel load model
getMetadata(<loadReg>)
Extracts and imports metadata from an rloadest loadReg model into an object of class "metadata"
getResiduals()
getResiduals return the residuals of the load.model
getRhoFirstOrderFun()
Produces a function that uses a first-order autocorrelation model to estimate the correlation between two dates.
getSmoothSplineInterpolation()
Generate a smoothing spline function with the parameters of your choice.
getTriangularInterpolation()
Generate a triangular interpolation function with the parameters of your choice.
interpModel-class
loadInterp is a class of load models that hold interpolation functions. The engine of a loadInterp model.
linearInterpolation() triangularInterpolation() rectangularInterpolation() splineInterpolation() smoothSplineInterpolation() distanceWeightedInterpolation()
Interpolation functions
isTimestepRegular()
Check a time series for evenly spaced dates.
loadComp-class
A load model class implementing the composite method for flux estimation.
loadComp()
Create a fitted loadComp object.
loadInterp-class
A load model class specific to interpolations for flux estimation.
loadInterp()
Create a fitted loadInterp object.
loadLm-class
A load model class specific to simple linear models (lms) for flux estimation.
loadLm()
Create a fitted loadLm object.
loadModel-class
A generic load model class.
loadModel()
Create a fitted loadModel object.
loadModelInterface
Functions implemented by any loadflex-compatible load model.
loadReg2-class
A load model class specific to loadReg objects produced by the USGS rloadest package.
loadReg2()
Create a fitted loadReg2 object.
loadflex-deprecated-data
Renamed or deprecated datasets for the loadflex package
exampleMetadata()
Deprecated functions in the loadflex package
loadflex
Models and Tools for Watershed Flux Estimates
logToLin() linToLog() mixedToLog()
Translate means and standard errors/deviations of lognormal distributions between log and linear space.
match.arg.loadflex()
Require an argument to match the loadflex conventions for that argument name
metadata-class
Store metadata relevant to a load model.
getCol() getUnits() getInfo()
Access information about a load model.
metadata() updateMetadata()
Create or modify the metadata for a load model.
observeSolute()
observeSolute - instantaneous loads or concentrations
plotEGRET()
Create an EGRET-style plot
predictSolute()
Make flux or concentration predictions from a load model.
predictSolute(<loadComp>)
Make flux or concentration predictions from a loadComp model.
predictSolute(<loadInterp>)
Make flux or concentration predictions from a loadInterp model.
predictSolute(<loadLm>)
Make flux or concentration predictions from a loadLm model.
predictSolute(<loadModel>)
Make flux or concentration predictions from a loadModel model.
predictSolute(<loadReg2>)
Make flux or concentration predictions from a loadReg2 model.
resampleCoefficients.lm()
Resample the coefficients of a linear model (lm)
resampleCoefficients.loadReg()
Resample the coefficients from a loadReg model.
residDurbinWatson()
Test for autocorrelation of residuals
show(<loadModel>)
Display a loadModel object
show(<metadata>)
Display a metadata object
simulateSolute()
Simulate solute concentrations based on the model and model uncertainty.
simulateSolute(<loadLm>)
Produce a set of predictions that reflect the coefficient uncertainty and natural variation.
simulateSolute(<loadModel>)
Produce a set of predictions that reflect the coefficient uncertainty and natural variation.
simulateSolute(<loadReg2>)
Produce a set of predictions that reflect the coefficient uncertainty and possibly also natural variation.
summarizeInputs()
Summarize the site and input data
summarizeModel()
Extract model summary statistics
summarizeModel(<loadComp>)
Extract model summary statistics from a loadComp model
summarizeModel(<loadInterp>)
Extract model summary statistics from a loadInterp model
summarizeModel(<loadLm>)
Extract model summary statistics from a loadLm model
summarizeModel(<loadModel>)
Extract model summary statistics from a loadModel model
summarizeModel(<loadReg>)
Extract model summary statistics from an rloadest::loadReg() model
summarizeModel(<loadReg2>)
Extract model summary statistics from a loadReg2 model
translateFreeformToUnitted()
Convert units from a greater variety of forms, including rloadest form, to unitted form
unitType()
Return the unit.type of a unit string
units_loadflex valid.metadata.units freeform.unit.translations unit.conversions
Units-related datasets for the loadflex package
validDim()
Determine whether a 1D dimension string is known and of the expected dimension type
validLoadModelInterface()
Test whether a class implements the loadModelInterface
validMetadataUnits()
Check whether these units are acceptable (without translation) for inclusion in metadata