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

Description Usage Arguments Details Value

View source: R/getCorr.R

Description

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

Usage

1
2
getCorr(dfr = NULL, folder = NULL, model = "tcsam02",
  minLevel = 0.95)

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

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 Dec. 14, 2018, 2:09 p.m.