467 lines
13 KiB
R
467 lines
13 KiB
R
|
|
#' @title Quick ApexCharts
|
|
#'
|
|
#' @description Initialize a chart with three main parameters :
|
|
#' data, mapping and type of chart.
|
|
#'
|
|
#' @param data Default dataset to use for chart. If not already
|
|
#' a `data.frame`, it will be coerced to with `as.data.frame`.
|
|
#' @param mapping Default list of aesthetic mappings to use for chart
|
|
#' @param type Specify the chart type. Available options:
|
|
#' `"column"`, `"bar"`,
|
|
#' `"line"`, `"step"`, `"spline"`,
|
|
#' `"area"`, `"area-step"`, `"area-spline"`,
|
|
#' `"pie"`, `"donut"`,
|
|
#' `"radialBar"`, `"radar"`, `"scatter"`,
|
|
#' `"heatmap"`, `"treemap"`,
|
|
#' `"timeline"` and `"dumbbell"`.
|
|
#' @param ... Other arguments passed on to methods. Not currently used.
|
|
#' @param synchronize Give a common id to charts to synchronize them (tooltip and zoom).
|
|
#' @param serie_name Name for the serie displayed in tooltip,
|
|
#' only used for single serie.
|
|
#' @inheritParams apexchart
|
|
#'
|
|
#' @return An [apexchart()] `htmlwidget` object.
|
|
#'
|
|
#' @export
|
|
#'
|
|
#' @importFrom rlang eval_tidy as_label
|
|
#' @importFrom utils modifyList
|
|
#' @importFrom stats complete.cases
|
|
#'
|
|
#' @example examples/apex.R
|
|
apex <- function(data, mapping,
|
|
type = "column",
|
|
...,
|
|
auto_update = TRUE,
|
|
synchronize = NULL,
|
|
serie_name = NULL,
|
|
width = NULL,
|
|
height = NULL,
|
|
elementId = NULL) {
|
|
type <- match.arg(
|
|
arg = type,
|
|
choices = c(
|
|
"column", "bar",
|
|
"rangeBar", "dumbbell",
|
|
"line", "spline", "step",
|
|
"area", "area-spline", "area-step",
|
|
"rangeArea",
|
|
"pie", "donut",
|
|
"radialBar",
|
|
"radar",
|
|
"polarArea",
|
|
"scatter", "bubble",
|
|
"heatmap",
|
|
"treemap",
|
|
"timeline",
|
|
"candlestick",
|
|
"boxplot"
|
|
)
|
|
)
|
|
data <- as.data.frame(data)
|
|
if (identical(type, "heatmap")) {
|
|
mapping <- rename_aes_heatmap(mapping)
|
|
} else {
|
|
mapping <- rename_aes(mapping)
|
|
}
|
|
if (identical(type, "scatter") & is_sized(mapping)) {
|
|
type <- "bubble"
|
|
}
|
|
mapdata <- lapply(mapping, rlang::eval_tidy, data = data)
|
|
type_no_compute <- c("candlestick", "boxplot", "timeline", "heatmap", "rangeArea", "rangeBar", "dumbbell")
|
|
if (is.null(mapdata$y) & !type %in% type_no_compute) {
|
|
mapdata <- compute_count(mapdata)
|
|
}
|
|
if (type %in% c("pie", "donut", "radialBar", "polarArea")) {
|
|
opts <- list(
|
|
chart = list(type = correct_type(type)),
|
|
series = list1(mapdata$y),
|
|
labels = list1(mapdata$x)
|
|
)
|
|
} else {
|
|
opts <- list(
|
|
chart = dropNulls(list(
|
|
type = correct_type(type),
|
|
group = synchronize
|
|
)),
|
|
series = make_series(mapdata, mapping, type, serie_name)
|
|
)
|
|
}
|
|
if (!is.null(synchronize)) {
|
|
opts$yaxis$labels$minWidth <- 15
|
|
}
|
|
opts <- modifyList(opts, choose_config(type, mapdata))
|
|
if (isTRUE(getOption("apex.axis.light", default = TRUE))) {
|
|
opts$yaxis$labels$style$colors <- "#848484"
|
|
opts$xaxis$labels$style$colors <- "#848484"
|
|
}
|
|
ax <- apexchart(
|
|
ax_opts = opts,
|
|
width = width,
|
|
height = height,
|
|
elementId = elementId,
|
|
auto_update = auto_update
|
|
)
|
|
if (inherits(mapdata$x, c("character", "Date", "POSIXt", "numeric", "integer")) & length(mapdata$x) > 0) {
|
|
ax$x$xaxis <- list(
|
|
min = min(mapdata$x, na.rm = TRUE),
|
|
max = max(mapdata$x, na.rm = TRUE)
|
|
)
|
|
}
|
|
ax$x$data <- data
|
|
ax$x$mapping <- mapping
|
|
ax$x$type <- type
|
|
ax$x$serie_name <- serie_name
|
|
class(ax) <- c(class(ax), "apex")
|
|
return(ax)
|
|
}
|
|
|
|
|
|
# Construct series
|
|
#' @importFrom rlang %||%
|
|
make_series <- function(mapdata, mapping, type = NULL, serie_name = NULL, force_datetime_names = FALSE) {
|
|
if (identical(type, "boxplot")) {
|
|
series <- parse_boxplot_data(mapdata, serie_name = serie_name)
|
|
} else if (identical(type, "candlestick")) {
|
|
if (!all(c("x", "open", "high", "low", "close") %in% names(mapping)))
|
|
stop("For candlestick charts 'x', 'open', 'high', 'low', and 'close' aesthetics must be provided.", call. = FALSE)
|
|
if (!is.null(mapdata$group))
|
|
warning("'group' aesthetic in candlestick chart is not supported", call. = FALSE)
|
|
mapdata$group <- NULL
|
|
series <- parse_candlestick_data(mapdata)
|
|
} else if (isTRUE(type %in% c("rangeBar", "timeline"))) {
|
|
if (!all(c("x", "start", "end") %in% names(mapping)))
|
|
stop("For timeline charts 'x', 'start', and 'end' aesthetics must be provided.", call. = FALSE)
|
|
if (is.null(mapdata$group))
|
|
mapdata$group <- serie_name %||% rlang::as_label(mapping$x)
|
|
series <- parse_timeline_data(mapdata)
|
|
} else if (isTRUE(type %in% c("dumbbell"))) {
|
|
if (!all(c("y", "x", "xend") %in% names(mapping)))
|
|
stop("For dumbbell charts 'x', 'xend', and 'y' aesthetics must be provided.", call. = FALSE)
|
|
if (is.null(mapdata$group))
|
|
mapdata$group <- serie_name %||% rlang::as_label(mapping$x)
|
|
series <- parse_dumbbell_data(mapdata)
|
|
} else {
|
|
mapdata <- as.data.frame(mapdata, stringsAsFactors = FALSE)
|
|
if (all(rlang::has_name(mapdata, c("ymin", "ymax")))) {
|
|
mapdata$y <- lapply(
|
|
X = seq_len(nrow(mapdata)),
|
|
FUN = function(i) {
|
|
list(mapdata$ymin[i], mapdata$ymax[i])
|
|
}
|
|
)
|
|
mapdata$ymin <- mapdata$ymax <- NULL
|
|
}
|
|
if (isTRUE(type %in% c("scatter", "bubble"))) {
|
|
complete <- complete.cases(mapdata[c("x", "y")])
|
|
n_missing <- sum(!complete)
|
|
if (n_missing > 0) {
|
|
mapdata <- mapdata[complete, ]
|
|
warning(sprintf("apex: Removed %s rows containing missing values", n_missing), call. = FALSE)
|
|
}
|
|
}
|
|
if (is.character(mapdata$x))
|
|
mapdata$x[is.na(mapdata$x)] <- "NA"
|
|
x_order <- unique(mapdata$x)
|
|
if (is_x_datetime(mapdata) & !identical(type, "rangeArea")) {
|
|
add_names <- force_datetime_names
|
|
x_order <- sort(x_order)
|
|
} else {
|
|
add_names <- names(mapdata)
|
|
}
|
|
if (is.null(serie_name) & !is.null(mapping$y))
|
|
serie_name <- rlang::as_label(mapping$y)
|
|
series <- list(dropNulls(list(
|
|
name = as.character(serie_name),
|
|
type = multi_type(type),
|
|
data = parse_df(mapdata, add_names = add_names)
|
|
)))
|
|
if (is_grouped(mapping)) {
|
|
mapdata <- rename_aes(mapdata)
|
|
len_grp <- tapply(mapdata$group, mapdata$group, length)
|
|
if (length(unique(len_grp)) > 1 & !isTRUE(type %in% c("scatter", "bubble"))) {
|
|
warning("apex: all groups must have same length! You can use `tidyr::complete` for this.")
|
|
}
|
|
series <- lapply(
|
|
X = unique(mapdata$group),
|
|
FUN = function(x) {
|
|
data <- mapdata[mapdata$group %in% x, ]
|
|
data <- data[, setdiff(names(data), "group"), drop = FALSE]
|
|
data <- data[order(match(x = data[["x"]], table = x_order, nomatch = 0L)), , drop = FALSE]
|
|
dropNulls(list(
|
|
name = as.character(x),
|
|
type = multi_type(type),
|
|
data = parse_df(
|
|
data = data,
|
|
add_names = add_names
|
|
)
|
|
))
|
|
}
|
|
)
|
|
}
|
|
}
|
|
series
|
|
}
|
|
|
|
is_grouped <- function(x) {
|
|
any(c("colour", "fill", "group") %in% names(x))
|
|
}
|
|
|
|
is_sized <- function(x) {
|
|
any(c("size", "z") %in% names(x))
|
|
}
|
|
|
|
#' @importFrom rlang quo
|
|
rename_aes_heatmap <- function(mapping) {
|
|
if (is.null(mapping["x"]))
|
|
stop("apex(..., type = 'heatmap') must have an 'x' aesthetic", call. = FALSE)
|
|
mapping[["x"]] <- quo(as.character(!!mapping[["x"]]))
|
|
n_mapping <- names(mapping)
|
|
n_mapping[n_mapping == "y"] <- "group"
|
|
if ("fill" %in% n_mapping) {
|
|
n_mapping[n_mapping == "fill"] <- "y"
|
|
}
|
|
if ("colour" %in% n_mapping) {
|
|
n_mapping[n_mapping == "colour"] <- "y"
|
|
}
|
|
names(mapping) <- n_mapping
|
|
return(mapping)
|
|
}
|
|
|
|
rename_aes <- function(mapping) {
|
|
if ("colour" %in% names(mapping)) {
|
|
names(mapping)[names(mapping) == "colour"] <- "group"
|
|
}
|
|
if ("fill" %in% names(mapping)) {
|
|
names(mapping)[names(mapping) == "fill"] <- "group"
|
|
}
|
|
if ("size" %in% names(mapping)) {
|
|
names(mapping)[names(mapping) == "size"] <- "z"
|
|
}
|
|
mapping
|
|
}
|
|
|
|
is_x_datetime <- function(mapdata) {
|
|
inherits(mapdata$x, what = c("Date", "POSIXt"))
|
|
}
|
|
list1 <- function(x) {
|
|
if (length(x) == 1) {
|
|
list(x)
|
|
} else {
|
|
x
|
|
}
|
|
}
|
|
|
|
|
|
# Change type of charts for helpers type
|
|
correct_type <- function(type) {
|
|
if (isTRUE(type %in% c("column"))) {
|
|
"bar"
|
|
} else if (isTRUE(type %in% c("spline", "step"))) {
|
|
"line"
|
|
} else if (isTRUE(type %in% c("area-spline", "area-step"))) {
|
|
"area"
|
|
} else if (isTRUE(type %in% c("timeline", "dumbbell"))) {
|
|
"rangeBar"
|
|
} else if (identical(type, "boxplot")) {
|
|
"boxPlot"
|
|
} else {
|
|
type
|
|
}
|
|
}
|
|
|
|
multi_type <- function(x) {
|
|
multis <- c("column", "area", "line",
|
|
"spline", "step", "scatter",
|
|
"bubble", "rangeArea")
|
|
if (isTRUE(x %in% multis)) {
|
|
correct_type(x)
|
|
} else {
|
|
NULL
|
|
}
|
|
}
|
|
|
|
range_num <- function(x) {
|
|
if (is.numeric(x) & length(x) > 0) {
|
|
p <- pretty(x)
|
|
list(
|
|
values = p,
|
|
n = length(p) - 1,
|
|
range = range(p)
|
|
)
|
|
} else {
|
|
NULL
|
|
}
|
|
}
|
|
|
|
#' @importFrom rlang %||%
|
|
compute_count <- function(mapdata) {
|
|
if (!is_grouped(mapdata)) {
|
|
x <- mapdata$x
|
|
weight <- mapdata$weight %||% rep(1, length(x))
|
|
count <- tapply(weight, x, sum, na.rm = TRUE, simplify = FALSE)
|
|
mapdata$x <- names(count)
|
|
mapdata$y <- as.numeric(count)
|
|
} else {
|
|
weight <- mapdata$weight %||% rep(1, length(mapdata$x))
|
|
count <- tapply(weight, mapdata[c("x", "group")], sum, na.rm = TRUE, simplify = FALSE)
|
|
mapdata$x <- rep(rownames(count), ncol(count))
|
|
mapdata$y <- unlist(count, use.names = FALSE)
|
|
mapdata$group <- rep(colnames(count), each = nrow(count))
|
|
}
|
|
mapdata$y[is.na(mapdata$y)] <- 0
|
|
return(mapdata)
|
|
}
|
|
|
|
|
|
|
|
# Configs ----
|
|
|
|
|
|
# Switch between auto configs according to type & mapping
|
|
choose_config <- function(type, mapdata) {
|
|
datetime <- is_x_datetime(mapdata)
|
|
range_x <- range_num(mapdata$x)
|
|
range_y <- range_num(mapdata$y)
|
|
if (identical(type, "boxplot")) {
|
|
box_horiz <- !is.numeric(mapdata$y) & is.numeric(mapdata$x)
|
|
}
|
|
switch(
|
|
type,
|
|
"bar" = config_bar(horizontal = TRUE),
|
|
"dumbbell" = config_bar(horizontal = TRUE, isDumbbell = TRUE),
|
|
"column" = config_bar(horizontal = FALSE, datetime = datetime),
|
|
"line" = config_line(datetime = datetime),
|
|
"area" = config_line(datetime = datetime),
|
|
"rangeArea" = config_line(datetime = datetime),
|
|
"spline" = config_line(curve = "smooth", datetime = datetime),
|
|
"step" = config_line(curve = "stepline", datetime = datetime),
|
|
"area-spline" = config_line(curve = "smooth", datetime = datetime),
|
|
"area-step" = config_line(curve = "stepline", datetime = datetime),
|
|
"scatter" = config_scatter(range_x = range_x, range_y = range_y, datetime = datetime),
|
|
"bubble" = config_scatter(range_x = range_x, range_y = range_y, datetime = datetime),
|
|
"timeline" = config_timeline(),
|
|
"candlestick" = config_candlestick(),
|
|
"boxplot" = config_boxplot(horizontal = box_horiz),
|
|
list()
|
|
)
|
|
}
|
|
|
|
|
|
# Config for column & bar charts
|
|
config_bar <- function(horizontal = FALSE, datetime = FALSE, isDumbbell = FALSE) {
|
|
config <- list(
|
|
dataLabels = list(enabled = FALSE),
|
|
plotOptions = list(
|
|
bar = list(
|
|
horizontal = horizontal,
|
|
isDumbbell = isDumbbell
|
|
)
|
|
),
|
|
tooltip = list(
|
|
shared = TRUE,
|
|
intersect = FALSE,
|
|
followCursor = TRUE
|
|
),
|
|
grid = list(
|
|
yaxis = list(lines = list(show = !isTRUE(horizontal))),
|
|
xaxis = list(lines = list(show = isTRUE(horizontal)))
|
|
)
|
|
)
|
|
if (isTRUE(datetime)) {
|
|
config$xaxis$type <- "datetime"
|
|
}
|
|
config
|
|
}
|
|
|
|
# Config for line, spline, area, area-spline
|
|
config_line <- function(curve = "straight", datetime = FALSE) {
|
|
config <- list(
|
|
dataLabels = list(enabled = FALSE),
|
|
stroke = list(
|
|
curve = curve,
|
|
width = 2
|
|
),
|
|
yaxis = list(
|
|
decimalsInFloat = 2
|
|
)
|
|
)
|
|
if (isTRUE(datetime)) {
|
|
config <- c(config, list(
|
|
xaxis = list(type = "datetime")
|
|
))
|
|
}
|
|
config
|
|
}
|
|
|
|
|
|
config_scatter <- function(range_x, range_y, datetime = FALSE) {
|
|
config <- list(
|
|
dataLabels = list(enabled = FALSE),
|
|
xaxis = list(
|
|
type = "numeric",
|
|
min = range_x$range[1],
|
|
max = range_x$range[2],
|
|
tickAmount = range_x$n,
|
|
# labels = list(formatter = format_num("~r")),
|
|
crosshairs = list(
|
|
show = TRUE,
|
|
stroke = list(dashArray = 0)
|
|
)
|
|
),
|
|
yaxis = list(
|
|
min = range_y$range[1],
|
|
max = range_y$range[2],
|
|
tickAmount = range_y$n,
|
|
labels = list(formatter = format_num("~r")),
|
|
tooltip = list(
|
|
enabled = TRUE
|
|
)
|
|
),
|
|
grid = list(
|
|
xaxis = list(
|
|
lines = list(
|
|
show = TRUE
|
|
)
|
|
)
|
|
)
|
|
)
|
|
if (isTRUE(datetime)) {
|
|
config$xaxis$type <- "datetime"
|
|
}
|
|
config
|
|
}
|
|
|
|
config_timeline <- function() {
|
|
list(
|
|
plotOptions = list(
|
|
bar = list(
|
|
horizontal = TRUE
|
|
)
|
|
),
|
|
xaxis = list(
|
|
type = "datetime"
|
|
)
|
|
)
|
|
}
|
|
|
|
config_candlestick <- function() {
|
|
list(
|
|
xaxis = list(
|
|
type = "datetime"
|
|
)
|
|
)
|
|
}
|
|
|
|
config_boxplot <- function(horizontal = FALSE) {
|
|
list(
|
|
plotOptions = list(
|
|
bar = list(
|
|
horizontal = horizontal
|
|
)
|
|
)
|
|
)
|
|
}
|
|
|