R/getResLst.R

In wStockhausen/rsimTCSAM: Simulation model for testing TCSAM2013 and TCSAM02 models.

#'
#'@title Create a rsimTCSAM.resLst object from a model run
#'
#'@description Function to create a rsimTCSAM.resLst object from a model run.
#'
#'@param path - path to folder with .RData object containing model run
#'@param rep - filename of .RData file
#'@param verbose - flag (T/F) to print diagnostic information
#'
#'@return a rsimTCSAM.resLst object.
#'
#'@details Uses \code{tcltk::tk_chose.file} to open a file dialog to select model .RData file
#'if path is NULL. A rsimTCSAM.resLst object is a list with elements
#'\itemize{
#'  \item{rep - a rsimTCSAM object, or NULL}
#'}
#'
#'@export
#'
getResLst<-function(path=NULL,rep="rsimTCSAM.RData",verbose=FALSE){
    if (is.null(path)){
        path<-tcltk::tk_choose.files(default="rsimTCSAM.RData",
                                     caption="Select file with model results",
                                     multi=FALSE,
                                     filters=matrix(data=c("*.RData",".RData"),nrow=1,ncol=2));
        if (length(path)==0) {
            cat("User canceled file selection!! Returning NULL as model results.\n")
            return(NULL);#user canceled file selection
        }
    } else {
        path<-file.path(path,rep);
    }

    cat("rsimTCSAM::getResLst(...): Reading model report from file:\n'",path,"'\n",sep='')
    if (!file.exists(path)) {
        cat("Warning from getResLst(...).\n");
        cat("--The following file does not exist:\n\t'",path,"'\n",sep='');
        cat("--Returning NULL.\n")
        return(NULL);
    }

    load(path,verbose=verbose);
    if(!any(names(rsim)=='mc')){
            cat("The file '",path,"'\n",
                "\tdoes not appear to be a rsimTCSAM model results file.\n",
                "\trsimTCSAM results files are R lists, with 'mc' as the first element.\n",
                "\tReturning NULL.\n",sep="");
            return(NULL);
    }
    if (!inherits(rsim,'rsimTCSAM')) class(rsim)<-c('rsimTCSAM',class(rsim));#set class attribute to 'rsimTCSAM' for identification
    
    resLst<-list(rep=rsim);
    class(resLst)<-c('rsimTCSAM.resLst',class(resLst));

    cat("rsimTCSAM::getResLst(...): Done!\n");
    return(resLst);
}