R/D3partitionR.R

In D3partitionR: Interactive Charts of Nested and Hierarchical Data with 'D3.js'

#' Plot D3partitionR object
#'
#' @import htmlwidgets
#' @param x A D3partitionR object to plot
#' @param width width of the widget in pixel/percent
#' @param height height of the widget in pixel/percent
#' @param elementId html id of the widget
#' @param sizingPolicy sizing policy
#' @param ... parameters for method consistency
#' @export
#' 
#' @examples
#' require(titanic)
#'require(data.table)
#'## Reading data
#'titanic_data = data.table(titanic::titanic_train)
#'
#'##Agregating data to have unique sequence for the 4 variables
#'var_names=c('Sex','Embarked','Pclass','Survived')
#'data_plot=titanic_data[,.N,by=var_names]
#'data_plot[,(var_names):=lapply(var_names,function(x){data_plot[[x]]=paste0(x,' ',data_plot[[x]])
#'})]
#'
#'## Plotting the chart
#'library("magrittr")
#'d3=D3partitionR() %>%
#'  add_data(data_plot,count = 'N',steps=c('Sex','Embarked','Pclass','Survived')) %>%
#'  add_title('Titanic')
#'\dontrun{
#'plot(d3)
#'}

plot.D3partitionR <- function(x, width = NULL, height = NULL, elementId = NULL, sizingPolicy = NULL, ...) {

    x =  compile_D3_partitionR(x)
    
    if(is.null(sizingPolicy)){
      sizingPolicy <- htmlwidgets::sizingPolicy(browser.fill=TRUE)
    }
    
    # create widget
    htmlwidgets::createWidget(name = "D3partitionR", x, width = width, height = height, package = "D3partitionR", elementId = elementId,sizingPolicy = sizingPolicy)
}

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

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