R/concatAnnualTables.R

In wStockhausen/wtsDisMELSConn: Functions for dealing with DisMELS IBM model output, including calculating and analyzing connectivity matrices

#'
#'@title Concatenate annual tables (connectivity matrices, individual connectivities, numbers by source), write to csv files
#'
#'@description Function to concatenate annual tables (connectivity matrices, individual connectivities, numbers by source), write to csv files.
#'
#'@param allRes - the allRes list from running calcConnectivityMatrices(...)
#'@param type - type of table to concatenate
#'@param writeCSV - flag (T/F) to write concatenated table to csv
#'@param folder - folder to write csv file
#'@param basename - base name for output csv file
#'
#'@return dataframe with concatenated matrices
#'
#'@details none.
#'
#'@export
#'
concatAnnualTables<-function(allRes=NULL,
                             type=c("prbSinkGivenSource","tblIndivConn","numSource"),
                             writeCSV=TRUE,
                             folder=getwd(),
                             basename=c('ConnMats','IndivConns','numsBySource')){
    nms<-names(allRes);
    dfrp<-NULL;
    for (nm in nms){
        #create output filename
        nmp<-strsplit(nm,'.',fixed=TRUE);
        nmp<-paste(nmp[[1]],collapse='');
        res<-allRes[[nm]];
        dfr<-res[[type]];
        dt<-list(date=rep(nmp,length.out=nrow(dfr)));
        dfr<-cbind(dt,dfr);
        dfrp<-rbind(dfrp,dfr);
    }
    dfrp$date<-as.numeric(as.character(dfrp$date)); #need this otherwise "date" is a factor
    
    if (writeCSV){
      if (!dir.exists(folder)) dir.create(folder,recursive=TRUE);
      outCSV<-file.path(folder,paste(basename,'.csv',sep=''));
      write.csv(dfrp,file=outCSV,row.names=FALSE);
    }
    
    return(invisible(dfrp));
}

#dfrConMats  <-concatAnnualTables(res.1996to2011$allRes,type="prbSinkGivenSource",basename='ATF.ConnMats');
#dfrIndivConn<-concatAnnualTables(res.1996to2011$allRes,type="tblIndivConn",basename='ATF.IndivConns');
#dfrNumBySrc <-concatAnnualTables(res.1996to2011$allRes,type="numSource",   basename='ATF.NumBySource');