R/templates.R

#' Collection of Header/Footer Templates
#'
#' @name templates
#' @param csid List of CSIDs
NULL

#' @rdname templates
templateHeader <- function(csid, username, cacheDir, figureDir) {

    if (length(csid) == 1) {

        csidString <- as.character(csid)

    } else {

        csidString <- paste("c(", paste(csid, collapse = ", "), ")", collapse = "", sep = "")

    }

    if (is.null(username)) {

        databaseLines <- "
con1 <- connectRootDB(con1)
con2 <- connectRootDB(con2, db = 'ndp')"

    } else {

            databaseLines <- sprintf("
con1 <- connectRootDB(con1, username = '%s', password = '')
con2 <- connectRootDB(con2, username = '%s', password = '', db = 'ndp')",
                                     username, username)

    }

    header <- sprintf("
#### Fast Analytics Skeleton Script

#####################################################
#### Setup ##########################################
#####################################################

library(rootBasics)
library(utilities)

csid <- %s
%s

cacheDir <- '%s'
figureDir <- '%s'
saveTag <- paste(csid, sep = '', collapse = '_')

cores <- 1

reprocess <- FALSE", csidString, databaseLines, cacheDir, figureDir)

    return(header)

}

#' @rdname templates
dataHeader <- function() {

    header <- sprintf("
#####################################################
#### Load Data ######################################
#####################################################
")

    return(header)

}

#' @rdname templates
processHeader <- function() {

    header <- sprintf("
#####################################################
#### Data Processing ################################
#####################################################
")

    return(header)

}


#' @rdname templates
plotHeader <- function() {

    header <- sprintf("
#####################################################
#### Plotting #######################################
#####################################################
")

    return(header)

}

#' @rdname templates
saveLine <- function(save) {

    save <- sprintf("
plotSave(sprintf('%s_%%s', saveTag), figureDir)", save)

    return(save)

}
mlhutchins/fast-analytics documentation built on May 23, 2019, 2:10 a.m.