estimate: estimate

In tbep-tech/tbepRSparrow: RSPARROW: An R system for SPARROW modeling

Description

Executes all model tasks related to model estimation, diagnostics plotting and mapping, parameter sensitivities, validation diagnostics, and the output of tabular summary metrics.

Executed By: controlFileTasksModel.R
Executes Routines:

• diagnosticPlotsNLLS.R

• diagnosticPlotsValidate.R

• diagnosticSensitivity.R

• errorOccurred.R

• estimateFeval.R

• estimateFevalNoadj.R

• estimateNLLSmetrics.R

• estimateNLLStable.R

• estimateOptimize.R

• named.list.R

• predict.R

• predictSummaryOutCSV.R

• unPackList.R

• validateMetrics.R

Usage

estimate(if_estimate, if_predict, file.output.list, class.input.list,
  dlvdsgn, estimate.input.list, minimum_reaches_separating_sites,
  DataMatrix.list, SelParmValues, Csites.weights.list, Csites.list,
  sitedata, numsites, if_validate, Vsites.list, vsitedata, subdata,
  Cor.ExplanVars.list, sitedata.landuse, vsitedata.landuse,
  sitedata.demtarea.class, vsitedata.demtarea.class, mapping.input.list,
  betavalues, if_estimate_simulation, batch_mode)

Arguments

if_estimate	yes/no indicating whether or not estimation is run
if_predict	yes/no indicating whether or not prediction is run
dlvdsgn	design matrix imported from design_matrix.csv
minimum_reaches_separating_sites	number indicating the minimum number of reaches separating sites
SelParmValues	selected parameters from parameters.csv using condition ifelse((parmMax > 0 | (parmType=="DELIVF" & parmMax>=0)) & (parmMin<parmMax) & ((parmType=="SOURCE" & parmMin>=0) | parmType!="SOURCE")
sitedata	Sites selected for calibration using subdata[(subdata$depvar > 0), ]
numsites	number of sites selected for calibration
if_validate	yes/no indicating whether or not validation is run
vsitedata	sitedata for validation. Calculated by subdata[(subdata$vdepvar > 0), ]
subdata	data.frame input data (subdata)
betavalues	data.frame of model parameters from parameters.csv
if_estimate_simulation	character string setting from sparrow_control.R indicating whether estimation should be run in simulation mode only.
batch_mode	yes/no character string indicating whether RSPARROW is being run in batch mode

Value

estimate.list named list of summary metrics and diagnostic output. For more details see documentation section 5.2.4

tbep-tech/tbepRSparrow documentation built on Oct. 9, 2020, 6:24 a.m.