R/build_site.R

In ropenscilabs/dataspice: Create Lightweight Schema.org Descriptions of Data

#' Build a dataspice site
#'
#' @param path (character) Path to a JSON+LD file with dataspice metadata
#' @param template_path (character) Optional. Path to a template for
#'  \code{\link[whisker]{whisker.render}}
#' @param out_path (character) Optional. Path to write the site's `index.html`
#' to. Defaults to `docs/index.html`.
#'
#' @return Nothing. Creates/overwrites \code{docs/index.html}
#' @export
#'
#' @examples
#' \dontrun{
#' # Create JSON+LD from a set of metadata templates
#' json <- write_json(biblio, access, attributes, creators)
#' build_site(json)
#' }
build_site <- function(path = file.path("data", "metadata", "dataspice.json"),
                       template_path = system.file("template.html5",
                                                   package = "dataspice"),
                       out_path = file.path("docs", "index.html")) {
  data <- jsonld_to_mustache(path)

  out_dir <- dirname(out_path)

  if (!dir.exists(out_dir)) {
    dir.create(out_dir, recursive = TRUE)
  }

  output <- whisker::whisker.render(
    readLines(template_path),
    data)

  # Build site
  writeLines(output, out_path)
}