R/readParamsCSV.R

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

#'
#'@title Read a TCSAM02 model parameters csv file and return a dataframe
#'
#'@description Function to read a TCSAM02 parameters csv file and return a dataframe.
#'
#'@param csvFile - parameters csv file from a TCSAM02 model run. can be NULL.
#'
#'@return a dataframe (or NULL).
#'
#'@details If csvFile is NULL, the user will be prompted to identify a
#'TCSAM02 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 parameters info csv file");
    } else {
        in.prs<-csvFile;
    }
    prs<-NULL;
    if (!is.null(in.prs)&&file.exists(in.prs)){
        prs<-utils::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(prs)
}