R/readParamsCSV.R

In wStockhausen/rTCSAM2015: A set of tools to set up input for, and interact with output from, a TCSAM2015 model run, as well as to compare TCSAM2015 and rsimTCSAM runs.

#'
#'@title Read a TCSAM2015 model parameters csv file and return a dataframe.
#'
#'@description Function to read a TCSAM2015 parameters csv file and return a dataframe.
#'
#'@param csvFile - parameters csv file from a TCSAM2015 model run. can be NULL.
#'
#'@return a dataframe (or NULL).
#'
#'@details If csvFile is NULL, the user will be prompted to identify a 
#'TCSAM2015 model parameters csv file to read. Uses functions
#'\itemize{
#'  \item \code{wtsUtilities::selectFile(...)}
#'}
#'
#'@export
#'
readParamsCSV<-function(csvFile=NULL){
    if (!is.character(csvFile)){
        in.prs<-wtsUtilities::selectFile(ext='csv',caption="Select active parameters info csv file");
    } else {
        in.prs<-csvFile;
    }
    obj.prs<-NULL;
    if (!is.null(in.prs)&&file.exists(in.prs)){
        obj.prs<-read.csv(in.prs,stringsAsFactors=FALSE);
    } else {
        cat('No parameters csv file specified, or file does not exist.\n',
            'Returning NULL...\n');
        return(NULL);
    }
    return(obj.prs)
}