R/markdown.R

In nverno/rstuff: Utilities and stuff

## Functions to help with markdown related tasks

##' Make nice for markdown
##' 
##' @param x input vector
##' @param type 'each' wraps each element in ``, 'all' wraps the whole vector in ``
##' @export
prettify <- function(x, type=c('each', 'all')) {
  tt <- match.arg(type, c('each', 'all'))
  if (tt == 'each') {
    gsub('([[:alnum:]]+)', '`\\1`', toString(x))
  } else if (tt == 'all') {
    sprintf('`%s`', toString(x))
  }
}

##' Convert input to list
##'
##' Print vector as a (ordered/unordered) list
##'
##' @param x Input vector
##' @param use.na If true, leave NA in result
##' @param type List type (ordered/unordered)
##' @export
pretty_list <- function(x, use.na=FALSE, type=c("ul", "ol")) {
  tstart <- match.arg(type, type)
  tend <- sub('<', "</", tstart)
  paste(c(tstart, sprintf("<li>%s</li>", if (use.na) x else na.omit(x)), 
    tend), collapse='\n')
}

##' Render and browse the file
##' 
##' @param file File name
##' @param format Optional output format
##' @export
see <- function(file, format) {
  if (!requireNamespace("rmarkdown")) {
    warning("this requires rmarkdown package")
    return(invisible())
  }
  if (!file.exists(file)) stop('Cant find file')
  out <- if (missing(format)) {
    rmarkdown::render(file)
  } else rmarkdown::render(file, output_format=format)
  browseURL(out)
}