inst/hclwizard/prepareStaticContent.R

In colorspace: A Toolbox for Manipulating and Assessing Colors and Palettes

# -------------------------------------------------------------------
# - NAME:        prepareStaticContent.R
# - AUTHOR:      Reto Stauffer
# - DATE:        2016-10-23
# -------------------------------------------------------------------
# - DESCRIPTION:
# -------------------------------------------------------------------
# - EDITORIAL:   2016-10-23, RS: Created file on pc24-c707.
# -------------------------------------------------------------------
# - L@ST MODIFIED: 2018-09-22 14:16 on marvin
# -------------------------------------------------------------------

   library("colorspace")


# -------------------------------------------------------------------
# Make bpy accessible
# -------------------------------------------------------------------

   # Make hidden function available
   bpy <- colorspace:::bpy

# -------------------------------------------------------------------
# Create color maps
# -------------------------------------------------------------------


   # Remove existing palettes
   imgdir <- "www/images"
   files <- list.files(imgdir,"pal_.*.png")
   if ( length(files) > 0 ) {
      for ( f in files ) file.remove(sprintf("%s/%s",imgdir,f))
   }

   # Loading defined color palettes from colorspace package
   palettes <- colorspace:::GetPaletteConfig(gui = TRUE)
   names(palettes) <- tolower(names(palettes))
   names(palettes)[names(palettes)=='typ'] <- "type"
   # Required for do.call
   GetPalette <- colorspace:::GetPalette

   N <- 7 # Default number of colors for the palettes
   idx <- which(! names(palettes) %in% c('name'))
   for ( i in 1:nrow(palettes) ) {
      args     <- as.list(palettes[i, idx])
      args$reverse <- FALSE
      name     <- gsub(" ","_", tolower(rownames(palettes)[i]))
      img      <- sprintf("%s/pal_%s.png", imgdir, name)
      cat(sprintf(" * Drawing: %s\n", img))

      if ( args$type == "base" ) {
         pal <- eval(parse(text = tolower(rownames(palettes)[i])))
      } else {
         pal <- do.call("GetPalette", args)
      }

      # Draw color map
      png(file = img, width = 300, height = 1)
      par(bty = "n", mar = rep(0, 4), oma = rep(0, 4))
      image(matrix(1:7, ncol = 1),col = pal(N))
      dev.off()
   }


# -------------------------------------------------------------------
# Snippet from:
# http://yihui.name/en/2012/10/build-static-html-help/
# Create static html from Rd files.
# -------------------------------------------------------------------
   static_help = function(pkg, methods, links = tools::findHTMLlinks()) {
     pkgRdDB = tools:::fetchRdDB(file.path(find.package(pkg), 'help', pkg))
     force(links); topics = names(pkgRdDB)
     for (p in topics) {
       if ( ! is.null(methods) ) {
         if ( ! p %in% methods ) next
       }
       message(sprintf("Create static html help page for %s::%s",pkg,p))
       content = pkgRdDB[[p]]
       tools::Rd2HTML(pkgRdDB[[p]], sprintf("tmp_%s.html",p),
                      package = pkg, Links = links, no_links = is.null(links))
     }
   }


   cat(" * Create static help pages using Rd2HTML\n")
   static_help("colorspace","choose_palette")
   static_help("colorspace","hcl_palettes")
   static_help("colorspace","specplot")
   static_help("colorspace","hclplot")


# -------------------------------------------------------------------
# Parsing html content and create new static help page for
# the hclwizard.
# -------------------------------------------------------------------
   # Reading help page content
   getHTMLcontent <- function(file) {
      # Helper function to extract the different sections
      extract <- function(html,sec) {
         ##r <- regmatches(html,regexpr(sprintf("<h3>%s</h3>.*?(?=<h3>)",sec),html,perl=TRUE))
         r <- regmatches(html,regexpr(sprintf("<h3>%s</h3>.*?(?=(<h3>|<hr\\s?/>|$))",sec),html,perl=TRUE))
         r <- gsub("#LB#","\n",r)
         r
      }
      title <- function(html) {
         r <- regmatches(html,regexpr("<h2>.*</h2>",html))
         r <- gsub("#LB#","\n",r)
         r
      }
      if ( ! file.exists(file) ) stop(sprintf("Cannot find %s",file))
      # Read content ... 
      html <- gsub("\\n","",paste(readLines(file),collapse="#LB#"))
      # Remove hyperrefs
      html <- gsub("</a>","",html,perl=TRUE)
      html <- gsub("<a href=.*?(?=>)>","",html,perl=TRUE)
      html <- gsub("Author\\Ws\\W","Authors",html)
      # ... and parse content
      res <- list()
      res[['Title']]       <- title(html)
      for ( sec in c("Description","Usage","Arguments","Details",
                     "Value","Authors","References","See Also") ) {
         res[[sec]]     <- extract(html,sec)
      }
      res
   }

   # Reading content
   cat(" * Reading html content\n")
   content1 <- getHTMLcontent("tmp_choose_palette.html")
   content2 <- getHTMLcontent("tmp_hcl_palettes.html")
   content3 <- getHTMLcontent("tmp_specplot.html")
   content4 <- getHTMLcontent("tmp_hclplot.html")

   # Create output file
   outfile <- "html/info.html"
   if ( file.exists("html/info.html") ) file.remove(outfile)
   cat("   Add authors on top\n")
   write(content1[["Authors"]], file=outfile, append=TRUE)

   # Create new help page content
   for ( sec in c("Title","Description","Details","Value") ) {
      cat(sprintf("   Appending %s\n",sec))
      write(content1[[sec]], file=outfile, append=TRUE)
   }
   for ( sec in c("Title","Description","Details","Value") ) {
      cat(sprintf("   Appending %s\n",sec))
      write(content2[[sec]], file=outfile, append=TRUE)
   }
   for ( sec in c("Title","Description","Details","Value") ) {
      cat(sprintf("   Appending %s\n",sec))
      write(content3[[sec]], file=outfile, append=TRUE)
   }
   for ( sec in c("Title","Description","Details","Value") ) {
      cat(sprintf("   Appending %s\n",sec))
      write(content4[[sec]], file=outfile, append=TRUE)
   }
   write(content1[["References"]], file=outfile, append=TRUE)

   # Remove temporary rendered html pages
   cat(" * Remove temporary files\n")
   file.remove("tmp_choose_palette.html")
   file.remove("tmp_hcl_palettes.html")
   file.remove("tmp_specplot.html")
   file.remove("tmp_hclplot.html")