R/workshop.R

In jarad/ISDSWorkshop: International Society for Disease Surveillance R Workshop

#' A function that prepares the workshop.
#'
#' @param write_data logical or string. If TRUE, writes all data sets. If FALSE, write no data sets. If string, vector of data sets to be written.
#' @param write_scripts logical or string. If TRUE, writes all scripts. If FALSE, write no scripts. If string, vector of scripts to be written.
#' @param launch_index logical. If TRUE, launches the workshop html index.
#' @details By default, the function uses the \code{\link{data}} function to load data sets and 
#'  then uses the \code{\link{write.csv}} function to write them to a file. 
#'  It then launches the \code{\link{ISDSWorkshop}} html index 
#'  using the \code{\link{vignette}} function. 
#' @seealso \code{\link{data}},\code{\link{GI}},\code{\link{write.csv}},\code{\link{ISDSWorkshop}}
#' @author Jarad Niemi <\url{http://jarad.me}>
#' @export
#' @examples
#' \dontrun{
#' workshop()
#' workshop(write_data = FALSE)
#' workshop(clean = FALSE) 
#' }
workshop = function(write_data    = TRUE, 
                    write_scripts = TRUE, 
                    launch_index  = TRUE) {
  
  # Write data
  if (write_data) 
    write_data = c('GI','icd9','fluTrends')
  
  if ("GI" %in% write_data) {
    data('GI', package='ISDSWorkshop', envir=environment())
    write.csv(get('GI', envir = environment()), 
              file="GI.csv", row.names=FALSE)
  }
  
  if ("icd9" %in% write_data) {
    data('icd9', package='ISDSWorkshop', envir=environment())
    write.csv(get('icd9', envir = environment()), 
              file='icd9.csv', row.names=FALSE)
  }
  
  if ("fluTrends" %in% write_data) {
    data('fluTrends', package='ISDSWorkshop', envir=environment())
    write.csv(get('fluTrends', envir=environment()),
              file = 'fluTrends.csv', row.names=FALSE)
  }
  
  
  # Write scripts
  if (write_scripts) {
    write_scripts = c("01_intro.R",
                      "02_graphics.R",
                      "03_advanced_graphics.R",
                      "04_advanced_R.R")
  } else {
    write_scripts = NULL
  }
  
  for (i in seq_along(write_scripts)) {
    script = write_scripts[i]
    file.copy(from = system.file("doc", script, package="ISDSWorkshop"),
              to   = script,
              overwrite = TRUE)
  }
  
  
  # Launch workshop index
  if (launch_index) 
    browseURL(system.file("doc", "workshop.html", package="ISDSWorkshop"))
}