R/C3Bar.R

Defines functions C3Bar C3BarOutput renderC3Bar

#' <Add Title>
#'
#' <Add Description>
#'
#' @import htmlwidgets
#'
#' @export
C3Bar <- function(dataset, categories, colors, 
                  width = NULL, height = NULL, elementId = NULL,
                  unload = FALSE) {
  
  if (length(names(dataset)) == 1) {
    groupings <- NULL
  } else {
    groupings <- list(names(dataset))
  }

  # forward options using x
  x = list(
    dataset = dataset,
    categories = categories,
    groups = groupings,
    colors = colors,
    unload = unload
  )
  
  # create widget
  htmlwidgets::createWidget(
    name = 'C3Bar',
    x,
    width = width,
    height = height,
    package = 'C3',
    elementId = elementId
  )
}

#' Shiny bindings for C3Bar
#'
#' Output and render functions for using C3Bar 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 C3Bar
#' @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 C3Bar-shiny
#'
#' @export
C3BarOutput <- function(outputId, width = '100%', height = '400px'){
  htmlwidgets::shinyWidgetOutput(outputId, 'C3Bar', width, height, package = 'C3')
}

#' @rdname C3Bar-shiny
#' @export
renderC3Bar <- function(expr, env = parent.frame(), quoted = FALSE) {
  if (!quoted) { expr <- substitute(expr) } # force quoted
  htmlwidgets::shinyRenderWidget(expr, C3BarOutput, env, quoted = TRUE)
}
maxmindlin/C3 documentation built on May 3, 2019, 4:04 p.m.