R/vizSkeleton.R

In USGS-VIZLAB/vizlab: Utilities for building online data visualizations

#' vizlab vizSkelton
#'
#' Create a skeleton for a new visualization
#'
#' @param name character vector containing viz name
#' @param path character vector of path to create skeleton
#' @examples
#' path <- file.path(tempdir(), "test")
#' vizSkeleton(name="test", path=path)
#' file.remove(path) # cleanup
#'
#' @importFrom methods getPackageName
#' @importFrom utils packageVersion
#' @export
vizSkeleton <- function (name = "cool-viz", path = ".") {
  create.empty.file <- function(path){
    emptypath <- file.path(path, ".empty")
    if(!file.exists(emptypath)){
      gitignore <- file(emptypath)
      cat(file=emptypath)
      close(gitignore)
    }
  }
  
  safe.dir.create <- function(path, createEmpty=FALSE) {
    if (!dir.exists(path) && !dir.create(path)){
      stop(gettextf("cannot create directory '%s'", path),
           domain = NA)
    }
    if(createEmpty) create.empty.file(path)
  }

  # Create directory structure
  message("Creating directories ...", domain = NA)
  safe.dir.create(path)
  safe.dir.create(file.path(path, "data"), createEmpty=TRUE)
  safe.dir.create(file.path(path, "images"), createEmpty=TRUE)
  safe.dir.create(file.path(path, "figures"), createEmpty=TRUE)
  safe.dir.create(layout_dir <- file.path(path, "layout"))
  safe.dir.create(file.path(layout_dir, "css"), createEmpty=TRUE)
  safe.dir.create(file.path(layout_dir, "js"), createEmpty=TRUE)
  safe.dir.create(file.path(layout_dir, "templates"), createEmpty=TRUE)
  safe.dir.create(script_dir <- file.path(path, "scripts"))
  safe.dir.create(file.path(script_dir, "fetch"), createEmpty=TRUE)
  safe.dir.create(file.path(script_dir, "process"), createEmpty=TRUE)
  safe.dir.create(file.path(script_dir, "visualize"), createEmpty=TRUE)
  safe.dir.create(file.path(script_dir, "read"), createEmpty=TRUE)

  # Write viz.yaml
  if(file.exists(file.path(path, 'viz.yaml'))) {
    message("viz.yaml already exists; leaving as-is")
  } else {
    message("Creating viz.yaml ...", domain = NA)
    viz.yaml <- file(file.path(path, "viz.yaml"))
    cat("vizlab: ", "\"", as.character(packageVersion(getPackageName())), "\"\n",
        "info:\n",
        "  id: ", name, "\n",
        "  name: ", "Visualization long name","\n",
        "  date: ", format(Sys.Date(), "%Y-%m-%d"), "\n",
        "  publish-date: ", format(Sys.Date() + 14, "%Y-%m-%d"), "\n",
        "  path: ", "/", name, "\n",
        "  analytics-id: ", "UA-78530187-1", "\n",
        "  description: >-\n",
        "    Describe project here\n",
        "  thumbnail:\n",
        "    url:\n",
        "    width: 250\n",
        "    height: 250\n",
        "    alttext:\n",
        "  required-packages:\n",
        "    vizlab:\n",
        "      repo: github\n",
        "      version: ", as.character(packageVersion('vizlab')), "\n",
        "      name: USGS-VIZLAB/vizlab\n",
        "      ref: v", as.character(packageVersion('vizlab')), "\n",
        "    dplyr:\n",
        "      repo: CRAN\n",
        "      version: 0.7.0\n",
        "parameter:\n",
        "fetch:\n",
        "process:\n",
        "visualize:\n",
        "publish:\n",
        file = viz.yaml, sep = "")
    close(viz.yaml)
  }

  # Write .gitignore file
  if (file.exists(file.path(path, '.gitignore'))) {
    message(".gitignore already exists, leaving as-is")
  } else {
    message("Creating .gitignore")
    gitignore <- file(file.path(path, ".gitignore"))
    cat(
        "cache/\n",
        "target/\n",
        "user/\n",
        "figures/\n",
        "vizlab/\n",
        "makefile\n",
        file = gitignore, sep = "")
    close(gitignore)
  }
  
  # Copy LICENSE file
  if (file.exists(file.path(path, 'LICENSE'))) {
    message("LICENSE already exists, leaving as-is")
  } else {
    message("Copying LICENSE")
    license <- file.copy(from=system.file('LICENSE', package="vizlab"),
                         to=file.path(path, 'LICENSE'))
  }
  
  # Read-and-delete-me type file would be good to describe next steps
}