Projects

For projects, the function scans a directory of local repositories and takes any directories found to be the names of projects. There is an exclude argument for dropping any known directories that are to be avoided. My defaults are exclude="leonawicz.github.io", "shiny-apps" since the first is just a local repository for my Github user account web site and not a “project” in the same sense of my other projects and the second is the local repository which is scanned by genPanelDiv when type="apps".

Apps

For apps, the function scans a directory of Shiny app subdirectories. Unlike for projects, where genPanelDiv scans a directory of multiple local repositories, this apps directory should be a specific local repository. The apps contained within are not individual repositories. I have taken this approach for now simply because this is how my apps tend to be stored.

Specifically, the genAppDiv looks for a named directory of image files. There should be one image per app, named exactly as the respective app directory is named. Only apps with corresponding images are built into the html container. If you wish to leave out, say, a developmental app from being linked to on you Github user website, do not include an image file for that app.

The container element includes an image link to each app’s url as well as a link to the source code on Github. Although the app scans for images in a local repository, the images referenced in the output html are of course not local. They point to the same images stored on Github, hence why it is useful for the local directory of apps to be a Github repository.

DataVis and Galleries

Whereas the first three types generate containers for the main Github user web page, I use type="gallery" to make a separate container html file of graphics for each panel occurring in my datavis container. These containers tend to be added to unique web pages. datavis is for highlighting a number of galleries whereas gallery is for each highlighted gallery’s respective contents.

In order to use type="datavis" there must be a data visualization local repository. Mine is named DataVisualizationExamples, evident from the hardcoding currently in place within this function. Similar to when type="apps", this repository includes a directory of images, in t his case one image for each gallery. Each image in this directory is named such that it identically matches another the name of a gallery images directory containing multiple images. As with type="apps", gallery directories are only included if a corresponding thumbnail image in the images directory exists.

When type="gallery", the behavior of genPanelDiv is most unique. For each gallery which exists, the function will make a unique html file with a gallery container element.

This function makes the more specific genAppDiv redundant and will likely replace it.

genPanelDiv <- function(outDir, type = "projects", main = "Projects", github.user = "leonawicz", 
    prjs.dir = "C:/github", exclude = c("leonawicz.github.io", "shiny-apps", 
        "eris2", "DataVisExamples", ".git", "_images"), img.loc = "_images/small", 
    lightbox = FALSE, include.buttons = TRUE, include.titles = TRUE, ...) {
    
    stopifnot(github.user %in% c("leonawicz", "ua-snap"))
    dots <- list(...)
    
    if (type == "apps") {
        filename <- "apps_container.html"
        web.url <- "http://shiny.snap.uaf.edu"
        gh.url.tail <- "shiny-apps/tree/master"
        atts <- " target=\"_blank\""
        go.label <- "Launch"
        prjs.dir <- file.path(prjs.dir, "shiny-apps")
        prjs.img <- list.files(file.path(prjs.dir, img.loc))
        prjs <- sapply(strsplit(prjs.img, "\\."), "[[", 1)
    }
    if (type == "projects") {
        filename <- "projects_container.html"
        web.url <- paste0("http://", github.user, ".github.io")
        gh.url.tail <- ""
        atts <- ""
        go.label <- "Website"
        prjs <- list.dirs(prjs.dir, full = TRUE, recursive = FALSE)
        prjs <- prjs[!(basename(prjs) %in% exclude)]
        prjs.img <- sapply(1:length(prjs), function(i, a) list.files(file.path(a[i], 
            "plots"), pattern = paste0("^_", basename(a)[i])), a = prjs)
        prjs <- basename(prjs)
    }
    if (type == "datavis") {
        filename <- "data-visualizations_container.html"
        web.url <- paste0("http://", github.user, ".github.io")
        gh.url.tail <- "DataVisExamples/tree/master"
        atts <- ""
        go.label <- "See More"
        prjs.dir <- file.path(prjs.dir, "DataVisExamples")
        prjs.img <- list.files(file.path(prjs.dir, img.loc))
        prjs <- sapply(strsplit(prjs.img, "\\."), "[[", 1)
    }
    if (type == "gallery") {
        web.url <- paste0("http://", github.user, ".github.io")
        gh.url.tail <- "DataVisExamples/tree/master"
        if (lightbox) 
            atts1 <- " data-lightbox=\"ID\"" else atts1 <- ""
        go.label <- "Expand"
        prjs <- list.dirs(file.path(prjs.dir, "DataVisExamples"), full = T, 
            recursive = F)
        prjs <- prjs[!(basename(prjs) %in% exclude)]
        prjs.img <- lapply(1:length(prjs), function(x, files, imgDir) list.files(path = file.path(files[x], 
            imgDir), recursive = FALSE), files = prjs, imgDir = img.loc)
        prjs <- basename(prjs)
        filename <- tolower(paste0("gallery-", gsub(" ", "-", gsub(" - ", " ", 
            prjs)), ".html"))
    }
    gh.url <- file.path("https://github.com", github.user, gh.url.tail)
    
    fillRow <- function(i, ...) {
        prj <- panels[i]
        go.label <- go.label[i]
        col <- col[i]
        panel.main <- panel.main[i]
        if (type == "apps") 
            img.src <- file.path(gsub("/tree/", "/raw/", gh.url), img.loc, prjs.img[i])
        if (type == "projects") 
            img.src <- file.path(gh.url, prj, "raw/master/plots", prjs.img[i])
        if (type == "datavis") 
            img.src <- file.path(gsub("/tree/", "/raw/", gh.url), img.loc, prjs.img[i])
        if (type != "gallery") {
            if (type == "datavis") {
                pfx <- "gallery-"
                sfx <- ".html"
                base <- tolower(paste0(pfx, gsub("_", "-", gsub("_-_", "-", 
                  prj)), sfx))
            } else {
                base <- prj
            }
            web.url <- file.path(web.url, base)
        } else {
            prj <- prjs[p]
            img.src <- file.path(gsub("/tree/", "/raw/", gh.url), prjs[p], img.loc, 
                panels[i])
            web.url <- file.path(gsub("/tree/", "/raw/", gh.url), prjs[p], panels[i])
            if (lightbox) 
                atts <- gsub("ID", gsub(" - ", ": ", gsub("_", " ", prjs[p])), 
                  atts1) else atts <- atts1
        }
        if (include.titles) {
            panel.title <- paste0("<div class=\"panel-heading\"><h3 class=\"panel-title\">", 
                panel.main, "</h3>\n          </div>\n          ")
        } else panel.title <- ""
        if (include.buttons) {
            if (go.label == "UAF ONLY") {
                web.url <- "#"
                atts <- ""
                go.btn <- "danger"
            } else go.btn <- "success"
            panel.buttons <- paste0("<div class=\"btn-group btn-group-justified\">\n\t\t\t<a href=\"", 
                web.url, "\"", atts, " class=\"btn btn-", go.btn, "\">", go.label, 
                "</a>\n\t\t\t<a href=\"", file.path(gh.url, prj), "\" class=\"btn btn-info\">Github</a>\n\t\t  </div>\n        ")
        } else panel.buttons <- ""
        x <- paste0("    <div class=\"col-lg-4\">\n      <div class=\"bs-component\">\n        <div class=\"panel panel-", 
            col, "\">\n          ", panel.title, "<div class=\"panel-body\"><a href=\"", 
            web.url, "\"", atts, "><img src=\"", img.src, "\" alt=\"", panel.main, 
            "\" width=100% height=200px></a><p></p>\n          ", panel.buttons, 
            "  </div>\n        </div>\n      </div>\n    </div>\n  ")
    }
    
    for (p in 1:length(filename)) {
        if (type == "gallery") {
            panels <- prjs.img[[p]]
            main <- gsub(" - ", ": ", gsub("_", " ", prjs[p]))
        } else panels <- prjs
        n <- length(panels)
        if (is.null(dots$go.label)) 
            go.label <- rep(go.label, length = n) else go.label <- rep(dots$go.label, length = n)
        if (is.null(dots$col)) 
            col <- rep("warning", length = n) else col <- rep(dots$col, length = n)
        if (is.null(dots$panel.main)) 
            panel.main <- gsub(" - ", ": ", gsub("_", " ", panels)) else panel.main <- rep(dots$panel.main, length = n)
        seq1 <- seq(1, n, by = 3)
        x <- paste0("<div class=\"container\">\n  <div class=\"row\">\n    <div class=\"col-lg-12\">\n      <div class=\"page-header\">\n        <h3 id=\"", 
            type, "\">", main, "</h3>\n      </div>\n    </div>\n  </div>\n  ")
        y <- c()
        for (j in 1:length(seq1)) {
            ind <- seq1[j]:(seq1[j] + 2)
            ind <- ind[ind %in% 1:n]
            y <- c(y, paste0("<div class=\"row\">\n", paste0(sapply(ind, fillRow, 
                panels = panels, go.label = go.label, col = col, panel.main = panel.main), 
                collapse = "\n"), "</div>\n"))
        }
        z <- "</div>\n"
        sink(file.path(outDir, filename[p]))
        sapply(c(x, y, z), cat)
        sink()
        cat("div container html file created.\n")
    }
}