R/readStdFile.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 std file and return a dataframe of class 'tcsam2015.std'
#'
#'@description Function to read a TCSAM2015 std file and return a dataframe of class 'tcsam2015.std'.
#'
#'@param stdfile - std file from a TCSAM2015 model run. can be NULL.
#'
#'@return a dataframe of class 'tcsam2015.std' (or NULL).
#'
#'@details If stdFile is NULL, the user will be prompted to identify a 
#'TCSAM2015 model std file to read. Uses functions
#'\itemize{
#'  \item \code{wtsUtilities::selectFile()}
#'}
#'
#'@export
#'
readStdFile<-function(stdFile=NULL){
    if (!is.character(stdFile)){
        in.std<-wtsUtilities::selectFile(ext='std',caption="Select TCSAM2015 std file");
    } else {
        in.std<-stdFile;
    }
    obj.std<-NULL;
    if (!is.null(in.std)&&file.exists(in.std)) {
        obj.std = read.table(in.std,as.is=T,header=F,skip=1);
        colnames(obj.std)<-c("row id","name","est","std.dev")
        class(obj.std)<-c('tcsam2015.std',class(obj.std));#set class attribute to 'tcsam2015.std' for identification
    } else {
        cat('No std file specified, or specified file does not exist.\n',
            'Returning NULL...\n');
        return(NULL);
    }
    return(obj.std)
}