R/amCharts.R

In datastorm-open/rAmCharts4: JavaScript Visualization using 'amcharts4' Library

#' @import htmlwidgets
#' @export
amCharts4 <- function(..., type, width = NULL, height = NULL) {

  x <- list(opts = list(...), type = type)
  # create the widget
  htmlwidgets::createWidget("rAmCharts4", x, width = width, height = height)
}

#' @export
amPieChart <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "PieChart", width = NULL, height = NULL)
}

#' @export
amXYChart <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "XYChart", width = NULL, height = NULL)
}

#' @export
amRadarChart <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "RadarChart", width = NULL, height = NULL)
}

#' @export
amSankeyDiagram <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "SankeyDiagram", width = NULL, height = NULL)
}

#' @export
amTreeMap <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "TreeMap", width = NULL, height = NULL)
}

#' @export
amChordDiagram <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "ChordDiagram", width = NULL, height = NULL)
}

#' @export
amSlicedChart <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "SlicedChart", width = NULL, height = NULL)
}

#' Gauge chart
#'
#' @export
#'
#' @examples
#' \dontrun{
#'    amGaugeChart(xAxes = list(list(type = "ValueAxis", min = 0, max = 100)))
#' }
#'
amGaugeChart <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "GaugeChart", width = NULL, height = NULL)
}



#' Sun burst
#'
#' @export
#'
#' @examples
#' \dontrun{
#'
#'    amSunburst(data = list(list(name = "f", value = 1), list( name = "s", value = 2)),
#'               dataFields =list(
#'                 value = "value",
#'                 name = "name"))
#'
#'
#' data = list(list(name = "First",
#'                             children = list(list(name = "A1" ,value = 100),
#'                                             list(name = "A2" ,value = 60),
#'                                             list(name = "A3" ,value = 30)
#'                             )),
#'                        list(
#'                          name = "Second",
#'                          children = list(list(name = "B1" ,value = 135),
#'                                          list(name = "B2" ,value = 98),
#'                                          list(name = "B3" ,value = 56)
#'                          )),
#'                        list(
#'                          name = "Third",
#'                          children = list(list(name = "C1" ,value = 335),
#'                                          list(name = "C2" ,value = 148),
#'                                          list(name = "C3" ,value = 126),
#'                                          list(name = "C4" ,value = 26)
#'                          )),
#'                        list(
#'                          name = "Fourth",
#'                          children = list(list(name = "D1" ,value = 415),
#'                                          list(name = "D2" ,value = 148),
#'                                          list(name = "D3" ,value = 89),
#'                                          list(name = "D4" ,value = 64),
#'                                          list(name = "D4" ,value = 16)
#'                          )),
#'                        list(
#'                          name = "Fifth",
#'                          children = list(list(name = "E1" ,
#'                                               children = list(
#'                                                 list(name = "EE1" ,value = 415),
#'                                                 list(name = "EE1" ,value = 256)
#'                                               )),
#'                                          list(name = "E2" ,value = 148)
#'                          ))
#' )
#' amSunburst(data = data,
#' dataFields =list(
#'   value = "value",
#'   name = "name",
#'   children = "children"))
#'
#' }
#'
amSunburst <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "Sunburst", width = NULL, height = NULL)
}



#' Word Cloud
#'
#' @export
#'
#' @examples
#' \dontrun{
#' amWordCloud(data = data.frame(tag = c("My", "Best", "Word"),
#'                               weight = c(100, 200, 300)),
#'             series = list(list(type = "WordCloudSeries",
#'                                dataFields = dataFields(
#'                                  word = "tag",
#'                                  value = "weight"))))
#'
#' }
#'
amWordCloud <- function(..., width = NULL, height = NULL){
  amCharts4(..., type = "WordCloud", width = NULL, height = NULL)
}


#' Shiny bindings for rAmCharts4
#'
#' Output and render functions for using rAmCharts4 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 rAmCharts4
#' @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.
#' @param shinyId single-element character vector indicating the output ID of the
#'   chart to modify (if invoked from a Shiny module, the namespace will be added
#'   automatically)
#' @param data A \code{data.frame}.
#' @param session the Shiny session object to which the chart belongs; usually the
#'   default value will suffice
#'
#' @name rAmCharts4-shiny
#'
#' @export
#' @importFrom htmlwidgets shinyWidgetOutput shinyRenderWidget
amCharts4Output <- function(outputId, width = '100%', height = '400px'){
  htmlwidgets::shinyWidgetOutput(outputId, 'rAmCharts4', width, height, package = 'rAmCharts4')
}

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


#' @rdname rAmCharts4-shiny
#' @export
amCharts4Proxy <- function(shinyId, data = NULL, session = shiny::getDefaultReactiveDomain()) {

  if (is.null(session)) {
    stop("amCharts4Proxy must be called from the server function of a Shiny app")
  }

  if (!is.null(session$ns) && nzchar(session$ns(NULL)) && substring(shinyId, 1, nchar(session$ns(""))) != session$ns("")) {
    shinyId <- session$ns(shinyId)
  }

  structure(
    list(
      session = session,
      id = shinyId,
      x = structure(
        list(data = data)
      )
    ),
    class = "amCharts4_Proxy"
  )
}