R/lci_page.R

In csp-inc/rmdy: CSP's rmarkdown 'remedy'

#' Convert to an HTML LCI Page
#'
#' A LCI Page is a lightweight webpage suitable for sharing.
#' @param toc Generate a Table of Contents? Defaults to \code{true}.
#' @param theme Visual theme. Defaults to \code{flatly}. Other good options may
#' include \code{journal}, \code{united}, \code{sandstone}, or \code{yeti}.
#' @param highlight Syntax highlighting style. Defaults to \code{tango}. Pass
#' \code{NULL} to prevent syntax highlighting.
#' @param smart Produce typographically correct output, converting straightquotes
#' to curly quotes, --- to em-dashes, -- to en-dashes, and ... to ellipses?
#' Defaults to \code{true}.
#' @param template Pandoc template to use for rendering. Defaults to the
#' rmarkdown package default template. Alternatively, pass \code{html_lci} to
#' use the rmdy package template .
#' @export

lci_page <- function(toc = TRUE, smart = TRUE, theme = "flatly",
                       highlight = "tango", template = "default", ...) {

  # get the locations of resource files located within the package
  resources_dir <- "rmarkdown/templates/lci_page/skeleton"
  if (template=="html_lci")
    template <- system.file(file.path(resources_dir, "default_fork.html"),
                            package = "rmdy")
  css <-
    system.file(file.path(resources_dir, "styles.css"), package = "rmdy")
  navbar <-
     system.file(file.path(resources_dir, "_navbar.html"), package = "rmdy")
  logo <-
    system.file(file.path(resources_dir, "logo.png"), package = "rmdy")
  navbar_html  <- readLines(navbar)
  new_navbar_html  <- sub(pattern = "logo.png", replace = logo, x = navbar_html)
  writeLines(new_navbar_html, con=file.path(getwd(), '_navbar.html'))
  footer <-
    system.file(file.path(resources_dir, "footer.html"), package = "rmdy")
  yaml <- system.file(file.path(resources_dir, "_site.yml"), package = "rmdy")
  file.copy(from = yaml, to = file.path(getwd(), '_site.yml'), overwrite=TRUE)

  # call the base html_document function
  rmarkdown::html_document(toc = toc,
                           smart = smart,
                           theme = theme,
                           highlight = highlight,
                           template = template,
                           css = css,
                           includes = rmarkdown::includes(after_body = footer),
                           ...)
}