R/options.R
In JohnCoene/chartist: chartist.js in R
Defines functions
opt_ist
lineopt_ist
baropt_ist
pieopt_ist
xaxis_ist
yaxis_ist
resp_ist
Documented in
baropt_ist
lineopt_ist
opt_ist
pieopt_ist
resp_ist
xaxis_ist
yaxis_ist
#' Configure options for chartist visualisation
#'
#' Pass any option to any chart here. Also see options specific to your chart
#' type, \code{\link{pieopt_ist}}, \code{\link{baropt_ist}} or
#' \code{\link{lineopt_ist}}
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param name name the serie, see details (optional).
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models) %>%
#' add_ist(wt) %>%
#' add_ist(drat) %>%
#' opt_ist(chartPadding = 10, width = 700, height = 200)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = qsec) %>%
#' add_ist(disp, name = "DISP") %>%
#' add_ist(hp, name = "HP") %>%
#' opt_ist(name = "DISP", lineSmoothing = "step") %>%
#' opt_ist(name = "HP",
#' showArea = TRUE,
#' showLine = FALSE,
#' showPoint = FALSE)
#'
#' @seealso \code{\link{baropt_ist}}, \code{\link{pieopt_ist}}, \code{\link{lineopt_ist}}
#'
#' @export
opt_ist <- function(p, name, width, height, low, high, chartPadding, ...){
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
if(!missing(name)) {
specopts <- list(opts)
names(specopts) <- name
p$x$options$series <- append(p$x$options$series, specopts)
} else {
p$x$options <- append(p$x$options, opts)
}
p
}
#' Line options
#'
#' Pass options to \code{line} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param name name the serie, see details (optional).
#' @param fillHoles whether to fill missing data, defaults to \code{FALSE}.
#' @param showPoint whether to show points, defaults to \code{TRUE}.
#' @param showArea turn line chart into area chart, defaults to \code{FALSE}.
#' @param lineSmoothing defaults to \code{simple}, can take an \code{integer},
#' \code{step}, \code{none} or an htmlwidgets javascript function
#' (class \code{JS_EVAL}).
#' @param showLine set \code{FALSE} to hide line.
#' @param fullWidth When set to true, the last grid line on the x-axis is not
#' drawn and the chart elements will expand to the full available width of the
#' chart. For the last label to be drawn correctly you might need to add chart
#' padding or offset the last label with a draw event handler.
#' @param distributeSeries distributed serie along x axis only works for 1
#' serie, defaults to \code{FALSE}.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param areaBase base for the chart, defaults to 0.
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp) %>%
#' lineopt_ist(showArea = TRUE, showLine = FALSE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp) %>%
#' lineopt_ist(lineSmoothing = "step", showLine = TRUE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp, name = "disp") %>%
#' add_ist(hp, name = "hp") %>%
#' lineopt_ist(name = "disp", lineSmoothing = "none") %>%
#' lineopt_ist(name = "hp", showArea = TRUE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(qsec) %>%
#' add_ist(mpg) %>%
#' lineopt_ist(lineSmoothing = htmlwidgets::JS("
#' Chartist.Interpolation.cardinal({tension: 0.2})"))
#'
#' @export
lineopt_ist <- function(p, name, fillHoles = FALSE, showPoint = TRUE,
showArea = FALSE, showLine = TRUE, areaBase = 0,
lineSmoothing = "simple", fullWidth = TRUE,
distributeSeries = FALSE, width, height, low, high,
chartPadding, ...){
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$areaBase <- if(!missing(areaBase)) areaBase
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts$showArea <- if(!missing(showArea)) showArea
opts$fullWidth <- if(!missing(fullWidth)) fullWidth
opts$showPoint <- if(!missing(showPoint)) showPoint
opts$showLine <- if(!missing(showLine)) showLine
if(is.numeric(lineSmoothing) || is.integer(lineSmoothing)) {
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.simple({divisor: ', lineSmoothing,'})')
} else if (lineSmoothing == "step"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.step()')
} else if (lineSmoothing == "none"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.none()')
} else if (lineSmoothing == "simple"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.simple()')
} else {
lineSmoothing
}
if(fillHoles == TRUE) {
opts$lineSmooth <- htmlwidgets::JS("Chartist.Interpolation.cardinal({fillHoles: true,})")
}
if(distributeSeries == TRUE){
p$x$cdat$series <- p$x$cdat$series[[1]]$data
opts$distributeSeries <- TRUE
}
if(!missing(name)) {
specopts <- list(opts)
names(specopts) <- name
p$x$options$series <- append(p$x$options$series, specopts)
} else {
p$x$options <- append(p$x$options, opts)
}
p
}
#' Bar options
#'
#' Pass options to \code{bar} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param fullWidth When set to true, the last grid line on the x-axis is not
#' drawn and the chart elements will expand to the full available width of the
#' chart. For the last label to be drawn correctly you might need to add chart
#' padding or offset the last label with a draw event handler.
#' @param stackBars whether to stack bars, default to \code{FALSE}.
#' @param distributeSeries distributed serie along x axis only works for 1
#' serie, defaults to \code{FALSE}.
#' @param centerBars set to \code{TRUE} to draw bars on the grid lines,
#' \code{FALSE} to draw on grid lines.
#' @param seriesBarDistance distance in pixels between bar groups.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- rownames(mtcars)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(cyl) %>%
#' add_ist(carb) %>%
#' add_ist(gear) %>%
#' baropt_ist(stackBars = TRUE)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(cyl) %>%
#' add_ist(carb) %>%
#' add_ist(gear) %>%
#' baropt_ist(seriesBarDistance = 10, centerBars = TRUE)
#'
#' @export
baropt_ist <- function(p, fullWidth = TRUE, centerBars = FALSE,
stackBars = FALSE, distributeSeries = FALSE,
seriesBarDistance, width, height, low, high,
chartPadding, ...){
opts <- list(...)
opts$seriesBarDistance <- if(!missing(seriesBarDistance)) seriesBarDistance
opts$centerBars <- if(!missing(centerBars)) centerBars
opts$stackBars <- if(!missing(stackBars)) stackBars
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts$fullWidth <- if(!missing(fullWidth)) fullWidth
if(distributeSeries == TRUE){
p$x$cdat$series <- p$x$cdat$series[[1]]$data
opts$distributeSeries <- TRUE
}
p$x$options <- append(p$x$options, opts)
p
}
#' Pie and donut options
#'
#' Pass options to \code{pie} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param percent convert to percent.
#' @param startAngle start angle of the pie chart in degrees.
#' @param total By specifying a total value, the sum of the values in the series
#' must be this total.
#' @param donut set to \code{TRUE} for donut chart, defaults to \code{FALSE}.
#' @param donutWidth donut width.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param labelOffset numeric to offset labels.
#' @param labelDirection label direction takes \code{neutral}, \code{explode}
#' or \code{implode}.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- rownames(mtcars)
#'
#' mtcars[1:5,] %>%
#' chart_ist(type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(startAngle = 270,
#' donut = TRUE,
#' donutWidth = 50,
#' showLabel = FALSE)
#'
#' mtcars[1:5,] %>%
#' chart_ist(x = models, type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(labelDirection = "explode",
#' labelOffset = 100,
#' chartPadding = 50)
#'
#' mtcars[1:5,] %>%
#' chart_ist(type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(percent = TRUE)
#'
#' @seealso \code{\link{gauge_ist}}
#'
#' @export
pieopt_ist <- function(p, percent = FALSE, donut = FALSE, showLabel = FALSE,
startAngle, total, donutWidth, labelDirection,
labelOffset, width, height, low, high, chartPadding, ...) {
opts <- list(...)
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$donut <- if(!missing(donut)) donut
opts$startAngle <- if(!missing(startAngle)) startAngle
opts$donut <- if(!missing(donut)) donut
opts$total <- if(!missing(total)) total
opts$donutWidth <- if(!missing(donutWidth)) donutWidth
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$labelDirection <- if(!missing(labelDirection)) labelDirection
opts$labelDirection <- if(!missing(labelDirection)) labelDirection
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
if(!missing(percent) && percent == TRUE) {
opts$labelInterpolationFnc = sumJS(p$x$cdat$series)
p$x$cdat$labels <- NULL
}
p$x$options <- append(p$x$options, opts)
p
}
#' Tweak X axis
#'
#' Tweak the x axis for chartist visualisation.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param showGrid set to \code{FALSE} to hide the grid.
#' @param offset offset axis.
#' @param suffix add suffix to label.
#' @param prefix add prefix to label.
#' @param position positon of axis.
#' @param labelOffset offset labels, takes \code{integer}, \code{vector} or
#' \code{list} (i.e.: \code{1}, \code{c(1,2)}, \code{list(x = 1, y = 2)}.
#' @param scaleMinSpace minimum height in pixel of scale.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:20,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(disp) %>%
#' xaxis_ist(showLabel = FALSE, showGrid = FALSE)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = mpg, type = "bar") %>%
#' add_ist(disp) %>%
#' xaxis_ist(suffix = "MPG", scaleMinSpace = 100)
#'
#' @export
xaxis_ist <- function(p, showLabel = TRUE, showGrid = TRUE, suffix = "",
prefix = "", position, offset, labelOffset, scaleMinSpace, ...){
opts <- list(...)
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$showGrid <- if(!missing(showGrid)) showGrid
opts$offset <- if(!missing(offset)) offset
opts$scaleMinSpace <- if(!missing(scaleMinSpace)) scaleMinSpace
opts$labelInterpolationFnc <- lab_ist(prefix, suffix)
p$x$options$axisX <- opts
p
}
#' Tweak Y axis
#'
#' Tweak the y axis for chartist visualisation.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param showGrid set to \code{FALSE} to hide the grid.
#' @param suffix add suffix to label.
#' @param prefix add prefix to label.
#' @param position positon of axis.
#' @param offset offset axis.
#' @param labelOffset offset labels, takes \code{integer}, \code{vector} or
#' \code{list} (i.e.: \code{1}, \code{c(1,2)}, \code{list(x = 1, y = 2)}.
#' @param scaleMinSpace minimum height in pixel of scale.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:5,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(disp) %>%
#' yaxis_ist(suffix = " $")
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = mpg, type = "bar") %>%
#' add_ist(disp) %>%
#' yaxis_ist(offset = 200, labelOffset = list(x = -50, y = 0))
#'
#' @export
yaxis_ist <- function(p, showLabel = TRUE, showGrid = TRUE, suffix = "",
prefix = "", position, offset, labelOffset, scaleMinSpace, ...){
opts <- list(...)
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$showGrid <- if(!missing(showGrid)) showGrid
opts$offset <- if(!missing(offset)) offset
opts$scaleMinSpace <- if(!missing(scaleMinSpace)) scaleMinSpace
opts$labelInterpolationFnc <- lab_ist(prefix, suffix)
p$x$options$axisY <- opts
p
}
#' Configure responsive options for chartist visualisation
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param query responsive query.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars %>%
#' chart_ist(models) %>%
#' add_ist(qsec) %>%
#' resp_ist(query = "screen and (max-width: 640px)", low = 15,
#' chartPadding = 50) %>%
#' resp_ist(query = "screen and (min-width: 641px) and (max-width: 1024px)",
#' chartPadding = 0)
#'
#' @export
resp_ist <- function(p, query, width, height, low, high, chartPadding, ...){
if(missing(query)) stop("missing query")
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts <- list(query, opts)
p$x$responsiveOptions <- append(p$x$responsiveOptions, opts)
p
}
JohnCoene/chartist documentation built on May 7, 2019, 11:17 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions opt_ist lineopt_ist baropt_ist pieopt_ist xaxis_ist yaxis_ist resp_ist
Documented in baropt_ist lineopt_ist opt_ist pieopt_ist resp_ist xaxis_ist yaxis_ist
#' Configure options for chartist visualisation
#'
#' Pass any option to any chart here. Also see options specific to your chart
#' type, \code{\link{pieopt_ist}}, \code{\link{baropt_ist}} or
#' \code{\link{lineopt_ist}}
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param name name the serie, see details (optional).
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models) %>%
#' add_ist(wt) %>%
#' add_ist(drat) %>%
#' opt_ist(chartPadding = 10, width = 700, height = 200)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = qsec) %>%
#' add_ist(disp, name = "DISP") %>%
#' add_ist(hp, name = "HP") %>%
#' opt_ist(name = "DISP", lineSmoothing = "step") %>%
#' opt_ist(name = "HP",
#' showArea = TRUE,
#' showLine = FALSE,
#' showPoint = FALSE)
#'
#' @seealso \code{\link{baropt_ist}}, \code{\link{pieopt_ist}}, \code{\link{lineopt_ist}}
#'
#' @export
opt_ist <- function(p, name, width, height, low, high, chartPadding, ...){
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
if(!missing(name)) {
specopts <- list(opts)
names(specopts) <- name
p$x$options$series <- append(p$x$options$series, specopts)
} else {
p$x$options <- append(p$x$options, opts)
}
p
}
#' Line options
#'
#' Pass options to \code{line} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param name name the serie, see details (optional).
#' @param fillHoles whether to fill missing data, defaults to \code{FALSE}.
#' @param showPoint whether to show points, defaults to \code{TRUE}.
#' @param showArea turn line chart into area chart, defaults to \code{FALSE}.
#' @param lineSmoothing defaults to \code{simple}, can take an \code{integer},
#' \code{step}, \code{none} or an htmlwidgets javascript function
#' (class \code{JS_EVAL}).
#' @param showLine set \code{FALSE} to hide line.
#' @param fullWidth When set to true, the last grid line on the x-axis is not
#' drawn and the chart elements will expand to the full available width of the
#' chart. For the last label to be drawn correctly you might need to add chart
#' padding or offset the last label with a draw event handler.
#' @param distributeSeries distributed serie along x axis only works for 1
#' serie, defaults to \code{FALSE}.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param areaBase base for the chart, defaults to 0.
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp) %>%
#' lineopt_ist(showArea = TRUE, showLine = FALSE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp) %>%
#' lineopt_ist(lineSmoothing = "step", showLine = TRUE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(x = mpg, type = "line") %>%
#' add_ist(disp, name = "disp") %>%
#' add_ist(hp, name = "hp") %>%
#' lineopt_ist(name = "disp", lineSmoothing = "none") %>%
#' lineopt_ist(name = "hp", showArea = TRUE, showPoint = FALSE)
#'
#' mtcars %>%
#' chart_ist(qsec) %>%
#' add_ist(mpg) %>%
#' lineopt_ist(lineSmoothing = htmlwidgets::JS("
#' Chartist.Interpolation.cardinal({tension: 0.2})"))
#'
#' @export
lineopt_ist <- function(p, name, fillHoles = FALSE, showPoint = TRUE,
showArea = FALSE, showLine = TRUE, areaBase = 0,
lineSmoothing = "simple", fullWidth = TRUE,
distributeSeries = FALSE, width, height, low, high,
chartPadding, ...){
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$areaBase <- if(!missing(areaBase)) areaBase
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts$showArea <- if(!missing(showArea)) showArea
opts$fullWidth <- if(!missing(fullWidth)) fullWidth
opts$showPoint <- if(!missing(showPoint)) showPoint
opts$showLine <- if(!missing(showLine)) showLine
if(is.numeric(lineSmoothing) || is.integer(lineSmoothing)) {
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.simple({divisor: ', lineSmoothing,'})')
} else if (lineSmoothing == "step"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.step()')
} else if (lineSmoothing == "none"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.none()')
} else if (lineSmoothing == "simple"){
opts$lineSmooth <- htmlwidgets::JS('Chartist.Interpolation.simple()')
} else {
lineSmoothing
}
if(fillHoles == TRUE) {
opts$lineSmooth <- htmlwidgets::JS("Chartist.Interpolation.cardinal({fillHoles: true,})")
}
if(distributeSeries == TRUE){
p$x$cdat$series <- p$x$cdat$series[[1]]$data
opts$distributeSeries <- TRUE
}
if(!missing(name)) {
specopts <- list(opts)
names(specopts) <- name
p$x$options$series <- append(p$x$options$series, specopts)
} else {
p$x$options <- append(p$x$options, opts)
}
p
}
#' Bar options
#'
#' Pass options to \code{bar} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param fullWidth When set to true, the last grid line on the x-axis is not
#' drawn and the chart elements will expand to the full available width of the
#' chart. For the last label to be drawn correctly you might need to add chart
#' padding or offset the last label with a draw event handler.
#' @param stackBars whether to stack bars, default to \code{FALSE}.
#' @param distributeSeries distributed serie along x axis only works for 1
#' serie, defaults to \code{FALSE}.
#' @param centerBars set to \code{TRUE} to draw bars on the grid lines,
#' \code{FALSE} to draw on grid lines.
#' @param seriesBarDistance distance in pixels between bar groups.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- rownames(mtcars)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(cyl) %>%
#' add_ist(carb) %>%
#' add_ist(gear) %>%
#' baropt_ist(stackBars = TRUE)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(cyl) %>%
#' add_ist(carb) %>%
#' add_ist(gear) %>%
#' baropt_ist(seriesBarDistance = 10, centerBars = TRUE)
#'
#' @export
baropt_ist <- function(p, fullWidth = TRUE, centerBars = FALSE,
stackBars = FALSE, distributeSeries = FALSE,
seriesBarDistance, width, height, low, high,
chartPadding, ...){
opts <- list(...)
opts$seriesBarDistance <- if(!missing(seriesBarDistance)) seriesBarDistance
opts$centerBars <- if(!missing(centerBars)) centerBars
opts$stackBars <- if(!missing(stackBars)) stackBars
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts$fullWidth <- if(!missing(fullWidth)) fullWidth
if(distributeSeries == TRUE){
p$x$cdat$series <- p$x$cdat$series[[1]]$data
opts$distributeSeries <- TRUE
}
p$x$options <- append(p$x$options, opts)
p
}
#' Pie and donut options
#'
#' Pass options to \code{pie} type.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param percent convert to percent.
#' @param startAngle start angle of the pie chart in degrees.
#' @param total By specifying a total value, the sum of the values in the series
#' must be this total.
#' @param donut set to \code{TRUE} for donut chart, defaults to \code{FALSE}.
#' @param donutWidth donut width.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param labelOffset numeric to offset labels.
#' @param labelDirection label direction takes \code{neutral}, \code{explode}
#' or \code{implode}.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- rownames(mtcars)
#'
#' mtcars[1:5,] %>%
#' chart_ist(type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(startAngle = 270,
#' donut = TRUE,
#' donutWidth = 50,
#' showLabel = FALSE)
#'
#' mtcars[1:5,] %>%
#' chart_ist(x = models, type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(labelDirection = "explode",
#' labelOffset = 100,
#' chartPadding = 50)
#'
#' mtcars[1:5,] %>%
#' chart_ist(type = "pie") %>%
#' add_ist(disp) %>%
#' pieopt_ist(percent = TRUE)
#'
#' @seealso \code{\link{gauge_ist}}
#'
#' @export
pieopt_ist <- function(p, percent = FALSE, donut = FALSE, showLabel = FALSE,
startAngle, total, donutWidth, labelDirection,
labelOffset, width, height, low, high, chartPadding, ...) {
opts <- list(...)
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$donut <- if(!missing(donut)) donut
opts$startAngle <- if(!missing(startAngle)) startAngle
opts$donut <- if(!missing(donut)) donut
opts$total <- if(!missing(total)) total
opts$donutWidth <- if(!missing(donutWidth)) donutWidth
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$labelDirection <- if(!missing(labelDirection)) labelDirection
opts$labelDirection <- if(!missing(labelDirection)) labelDirection
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
if(!missing(percent) && percent == TRUE) {
opts$labelInterpolationFnc = sumJS(p$x$cdat$series)
p$x$cdat$labels <- NULL
}
p$x$options <- append(p$x$options, opts)
p
}
#' Tweak X axis
#'
#' Tweak the x axis for chartist visualisation.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param showGrid set to \code{FALSE} to hide the grid.
#' @param offset offset axis.
#' @param suffix add suffix to label.
#' @param prefix add prefix to label.
#' @param position positon of axis.
#' @param labelOffset offset labels, takes \code{integer}, \code{vector} or
#' \code{list} (i.e.: \code{1}, \code{c(1,2)}, \code{list(x = 1, y = 2)}.
#' @param scaleMinSpace minimum height in pixel of scale.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:20,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(disp) %>%
#' xaxis_ist(showLabel = FALSE, showGrid = FALSE)
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = mpg, type = "bar") %>%
#' add_ist(disp) %>%
#' xaxis_ist(suffix = "MPG", scaleMinSpace = 100)
#'
#' @export
xaxis_ist <- function(p, showLabel = TRUE, showGrid = TRUE, suffix = "",
prefix = "", position, offset, labelOffset, scaleMinSpace, ...){
opts <- list(...)
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$showGrid <- if(!missing(showGrid)) showGrid
opts$offset <- if(!missing(offset)) offset
opts$scaleMinSpace <- if(!missing(scaleMinSpace)) scaleMinSpace
opts$labelInterpolationFnc <- lab_ist(prefix, suffix)
p$x$options$axisX <- opts
p
}
#' Tweak Y axis
#'
#' Tweak the y axis for chartist visualisation.
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param showLabel set to \code{FALSE} to hide labels.
#' @param showGrid set to \code{FALSE} to hide the grid.
#' @param suffix add suffix to label.
#' @param prefix add prefix to label.
#' @param position positon of axis.
#' @param offset offset axis.
#' @param labelOffset offset labels, takes \code{integer}, \code{vector} or
#' \code{list} (i.e.: \code{1}, \code{c(1,2)}, \code{list(x = 1, y = 2)}.
#' @param scaleMinSpace minimum height in pixel of scale.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:5,] %>%
#' chart_ist(x = models, type = "bar") %>%
#' add_ist(disp) %>%
#' yaxis_ist(suffix = " $")
#'
#' mtcars[1:10,] %>%
#' chart_ist(x = mpg, type = "bar") %>%
#' add_ist(disp) %>%
#' yaxis_ist(offset = 200, labelOffset = list(x = -50, y = 0))
#'
#' @export
yaxis_ist <- function(p, showLabel = TRUE, showGrid = TRUE, suffix = "",
prefix = "", position, offset, labelOffset, scaleMinSpace, ...){
opts <- list(...)
opts$labelOffset <- if(!missing(labelOffset)) labelOffset
opts$showLabel <- if(!missing(showLabel)) showLabel
opts$showGrid <- if(!missing(showGrid)) showGrid
opts$offset <- if(!missing(offset)) offset
opts$scaleMinSpace <- if(!missing(scaleMinSpace)) scaleMinSpace
opts$labelInterpolationFnc <- lab_ist(prefix, suffix)
p$x$options$axisY <- opts
p
}
#' Configure responsive options for chartist visualisation
#'
#' @param p a chartist object.
#' @param ... additional options.
#' @param query responsive query.
#' @param width set fixed width in pixels or percent (i.e.: \code{300px}, \code{70\%}).
#' @param height set fixed height in pixels or percent
#' (i.e.: \code{300px}, \code{70\%}).
#' @param low lower bound of value.
#' @param high higher bound of value.
#' @param chartPadding padding around chart div.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars %>%
#' chart_ist(models) %>%
#' add_ist(qsec) %>%
#' resp_ist(query = "screen and (max-width: 640px)", low = 15,
#' chartPadding = 50) %>%
#' resp_ist(query = "screen and (min-width: 641px) and (max-width: 1024px)",
#' chartPadding = 0)
#'
#' @export
resp_ist <- function(p, query, width, height, low, high, chartPadding, ...){
if(missing(query)) stop("missing query")
opts <- list(...)
opts$width <- if(!missing(width)) width
opts$height <- if(!missing(height)) height
opts$low <- if(!missing(low)) low
opts$high <- if(!missing(high)) high
opts$chartPadding <- if(!missing(chartPadding)) chartPadding
opts <- list(query, opts)
p$x$responsiveOptions <- append(p$x$responsiveOptions, opts)
p
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.