getCorr: Find substantially-correlated model parameters, based on the...

In wStockhausen/rTCSAM02: A set of tools to set up input for, and interact with output from, TCSAM02 model runs

Find substantially-correlated model parameters, based on the model "cor" file

Description

Function to find substantially-correlated model parameters, based on the model "cor" file.

Usage

getCorr(
  dfr = NULL,
  folder = NULL,
  model = "tcsam02",
  minLevel = 0.95,
  verbose = FALSE
)

Arguments

dfr	dataframe from a call to readCorFile, or NULL
folder	folder containing the model run (if dfr is NULL)
model	model name (default is "tcsam02")
minLevel	minimum correlation level to use to report parameters
verbose	flag to print debugging info

Details

This function extracts "substantially"-correlated parameters (ultimately) from the model "cor" file, where "substantial" is based on the value of minLevel. A dataframe with the parameter names and correlation values is returned.

Value

a dataframe

wStockhausen/rTCSAM02 documentation built on April 16, 2024, 6:25 a.m.