R/hierplane.R

In tyluRp/hierplane: What the Package Does (One Line, Title Case)

#' Render a hierplane
#'
#' Hierplanes visualize hierarchical data. The `.data` param expects a hierplane
#' object created by various inputs using the `hp_` family of functions.
#'
#' @param .data A dataframe containing hierarchical features.
#' @param theme Either light, dark, grey, or pink.
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
#'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
#'   string and have \code{'px'} appended.
#' @param elementId Explicitly provide an element ID to the widget rather than
#' an automatically generated one. This is optional.
#'
#' @import htmlwidgets
#' @source https://github.com/allenai/hierplane
#'
#' @export
hierplane <- function(.data, theme = "light", width = NULL, height = NULL,
                      elementId = NULL) {
  # forward options using x
  x <- list(
    tree = .data,
    theme = theme
  )

  # create widget
  htmlwidgets::createWidget(
    name = 'hierplane',
    x,
    width = width,
    height = height,
    package = 'hierplane',
    elementId = elementId
  )
}

#' Shiny bindings for hierplane
#'
#' Output and render functions for using hierplane within Shiny
#' applications and interactive Rmd documents.
#'
#' @param outputId output variable to read from
#' @param width,height Must be a valid CSS unit (like \code{'100\%'},
#'   \code{'400px'}, \code{'auto'}) or a number, which will be coerced to a
#'   string and have \code{'px'} appended.
#' @param expr An expression that generates a hierplane
#' @param env The environment in which to evaluate \code{expr}.
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
#'   is useful if you want to save an expression in a variable.
#'
#' @name hierplane-shiny
#'
#' @export
hierplaneOutput <- function(outputId, width = '100%', height = '400px'){
  htmlwidgets::shinyWidgetOutput(outputId, 'hierplane', width, height, package = 'hierplane')
}

#' @rdname hierplane-shiny
#' @export
renderHierplane <- function(expr, env = parent.frame(), quoted = FALSE) {
  if (!quoted) { expr <- substitute(expr) } # force quoted
  htmlwidgets::shinyRenderWidget(expr, hierplaneOutput, env, quoted = TRUE)
}