R/D3Scatter.R

In gusef/d3Toolbox: Toolbox of interactive visualizations for R/Shiny powered by javascript and d3.js

#' Scatterplot based on d3
#'
#'
#'
#' @import htmlwidgets
#'
#' @export
d3Scatter <- function(data, col='black', dotsize =3.5, xlab='', ylab='',
                      title=NULL, subtitle=NULL, callback='ScatterSelection',
                      tooltip=NULL, legend=NULL,legend_title=NULL,legend_pos='topright',
                      legend_right_offset = 100, width = NULL, height = NULL,
                      xrange=NULL, yrange=NULL, margins = NULL,
                      col_scale = RColorBrewer::brewer.pal(11,"RdBu")[11:1],
                      elementId = NULL, collection = FALSE) {

    if (is.null(margins)){
        margins <- list(top = 40,
                        right = 20,
                        bottom = 50,
                        left = 60)
    }

    #if a numeric value was provided use the color scale to transform
    if (is.numeric(col)){
        if (length(col) != nrow(data)){
            stop('If "col" is numeric there has to be a value for each data row')
        }
        breaks <- seq(min(col, na.rm = T),
                      max(col, na.rm = T),
                      length = length(col_scale) + 1 )
        grps <- cut(col, breaks = breaks, include.lowest = TRUE)
        col <- col_scale[grps]
    }else{
        #Fix the coloring
        col <- gplots::col2hex(col)

        if(length(col)==1){
            col <- rep(col,nrow(data))
        }
    }
    data$col <- col

    if (!is.null(xrange) && length(xrange) != 2){
        stop("If xrange is specified it needs to have a length of 2")
    }

    if (!is.null(yrange) && length(yrange) != 2){
        stop("If yrange is specified it needs to have a length of 2")
    }

    #Add names as separate column instead of rownames
    data$name <- rownames(data)
    rownames(data) <- NULL

    #fix the labels
    if (xlab==''){
        xlab <- names(data)[1]
    }

    if (ylab==''){
        ylab <- names(data)[2]
    }
    names(data)[1:2] <- c('x','y')

    #figure out legend positioning
    if (!is.null(legend)){
        if (legend_pos == 'topleft'){
            legend_pos <- c(0,0)
        }else if (legend_pos == 'top'){
            legend_pos <- c(0,1)
        }else if (legend_pos == 'topright'){
            legend_pos <- c(0,2)
        }else if (legend_pos == 'right'){
            legend_pos <- c(1,2)
        }else if (legend_pos == 'bottomright'){
            legend_pos <- c(2,2)
        }else if (legend_pos == 'bottom'){
            legend_pos <- c(2,1)
        }else if (legend_pos == 'bottomleft'){
            legend_pos <- c(2,0)
        }else if (legend_pos == 'left'){
            legend_pos <- c(1,0)
        }else{
            stop('legend_pos needs to be "top","right","left","bottom","bottomright",..')
        }
    }

    # forward options using x
    x = list(
        type = "d3Scatter",
        data = data,
        dotsize = dotsize,
        xlab = xlab,
        ylab = ylab,
        xrange = xrange,
        yrange = yrange,
        title = title,
        subtitle = subtitle,
        tooltip=tooltip,
        legend=legend,
        legend_title=legend_title,
        legend_pos=legend_pos,
        legend_right_offset=legend_right_offset,
        margins=margins,
        callback = callback
    )

    if (collection){
        return(x)
    }else{
        # create widget
        htmlwidgets::createWidget(
            name = 'd3Scatter',
            x,
            width = width,
            height = height,
            package = 'd3Toolbox',
            elementId = elementId,
            sizingPolicy = htmlwidgets::sizingPolicy(browser.fill = TRUE)
        )
    }

}

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

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