R/render_html_fragment.R

In bsplus: Adds Functionality to the R Markdown + Shiny Bootstrap Framework

#' Renders and returns an HTML fragment
#'
#' This is a wrapper around the `rmarkdown::[render][rmarkdown::render]`
#' function. The principal difference is that the function is designed to
#' return an HTML fragment (rather than writing to a file). This function is
#' useful to populate the content of a modal window.
#'
#' This function is being deprecated in favor of
#'  `shiny::[includeMarkdown][shiny::includeMarkdown]`
#'
#' @param input          character, path to input file
#' @param output_format  rmarkdown output format, provided so you can specify arguments
#' @param ...            other arguments passed to
#'   `rmarkdown::[render][rmarkdown::render]`
#'
#' @return `htmltools::[tag][htmltools::tag]`
#' @examples
#' \dontrun{
#' my_file <- system.file("markdown", "modal.md", package = "bsplus")
#' render_html_fragment(my_file)
#' }
#' @export
#'
render_html_fragment <- function(input,
                                 output_format = rmarkdown::html_fragment(),
                                 ...){

  .Deprecated("shiny::includeMarkdown")

  tempfile_html <- tempfile()

  rmarkdown::render(input, output_format, output_file = tempfile_html, ...)

  tempfile_html %>%
    readLines() %>%
    htmltools::HTML()

}