R/getCorr.R

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

#'
#' @title 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.
#'
#' @param dfr - dataframe from a call to readCorFile, or NULL
#' @param folder - folder containing the model run (if dfr is NULL)
#' @param model - model name (default is "tcsam02")
#' @param minLevel - minimum correlation level to use to report parameters
#' @param verbose - flag to print debugging info
#'
#' @return a dataframe
#'
#' @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.
#'
#' @export
#'
getCorr<-function(dfr=NULL,
                  folder=NULL,
                  model="tcsam02",
                  minLevel=0.95,
                  verbose=FALSE){
  if (is.null(dfr)) dfr <- readCorFile(folder=folder,model=model,verbose=verbose);

  dfr.cor <- dfr[(dfr$p_i!=dfr$p_j)&(abs(dfr$val)>=minLevel),c("p_i","p_j","val")];

  return(dfr.cor);
}