apexcharter/vignettes/apexcharter.Rmd

---
title: "Starting with ApexCharts"
author: "Victor Perrier"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Starting with ApexCharts}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  screenshot.force = FALSE
)
```

The objective of this vignette is to show how to quickly build data visualizations with the ApexCharts JavaScript library, as well as to give an overview of the different graphics available.

Data used are from `ggplot2` package.


```{r packages, message=FALSE, warning=FALSE}
library(ggplot2)
library(scales)
library(apexcharter)
```


## Bar charts

Simple bar charts can be created with:

```{r column}
data("mpg")

apex(data = mpg, type = "column", mapping = aes(x = manufacturer))
```

Flipping coordinates can be done by using `type = "bar"`:

```{r bar}
apex(data = mpg, type = "bar", mapping = aes(x = manufacturer))
```


To create a dodge bar charts, use aesthetic `fill` :

```{r dodge-bar}
apex(data = mpg, type = "column", mapping = aes(x = manufacturer, fill = year))
```

For stacked bar charts, specify option `stacked` in `ax_chart` :

```{r stacked-bar}
apex(data = mpg, type = "column", mapping = aes(x = manufacturer, fill = year)) %>% 
  ax_chart(stacked = TRUE)
```



## Line charts

Simple line charts can be created with (works with `character`, `Date` or `POSIXct`):

```{r line}
data("economics")

apex(data = economics, type = "line", mapping = aes(x = date, y = uempmed))
```


To represent several lines, use a `data.frame` in long format and the `group` aesthetic:

```{r lines}
data("economics_long")

apex(data = economics_long, type = "line", mapping = aes(x = date, y = value01, group = variable)) %>% 
  ax_yaxis(decimalsInFloat = 2) # number of decimals to keep
```


## Area charts

Create area charts with `type = "area"`:

```{r area}
data("eco2mix", package = "apexcharter")

apex(eco2mix, aes(datetime, production, fill = source), type = "area") %>% 
  ax_chart(animations = list(enabled = FALSE), stacked = TRUE) %>% 
  ax_stroke(width = 1) %>% 
  ax_fill(opacity = 1, type = "solid") %>% 
  ax_tooltip(x = list(format = "dd MMM, HH:mm")) %>% 
  ax_yaxis(labels = list(formatter = format_num("~", suffix = "MW"))) %>% 
  ax_colors_manual(
    list(
      "bioenergies" = "#156956",
      "fuel" = "#80549f",
      "coal" = "#a68832",
      "solar" = "#d66b0d",
      "gas" = "#f20809",
      "wind" = "#72cbb7",
      "hydraulic" = "#2672b0",
      "nuclear" = "#e4a701",
      "pumping" = "#0e4269"
    )
  ) %>% 
  ax_labs(
    title = "Electricity generation by sector in France",
    subtitle = "Data from \u00e9CO\u2082mix"
  )
```


You can create ribbon charts using `ymin` and `ymax` aesthetics :

```{r ribbon}
data("temperatures", package = "apexcharter")

apex(
  temperatures, 
  aes(x = date, ymin = low, ymax = high), 
  type = "rangeArea", 
  serie_name = "Low/High (2018-2021)"
) %>% 
  add_line(aes(date, `2023`)) %>% 
  ax_chart(animations = list(enabled = FALSE)) %>% 
  ax_yaxis(tickAmount = 7, labels = list(formatter = format_num("~", suffix = "°C"))) %>% 
  ax_colors(c("#8485854D", "#FF0000")) %>%
  ax_stroke(width = c(1, 2)) %>% 
  ax_fill(opacity = 1, type = "solid") %>% 
  ax_labs(
    title = "Temperatures in 2023 with range from 2018 to 2021",
    subtitle = "Data from ENEDIS"
  )
```




## Scatter charts

Simple bar charts can be created with:

```{r scatter}
apex(data = mtcars, type = "scatter", mapping = aes(x = wt, y = mpg))
```

Color points according to a third variable:

```{r scatter-fill}
apex(data = mtcars, type = "scatter", mapping = aes(x = wt, y = mpg, fill = cyl))
```

And change point size using `z` aesthetics:

```{r bubbles}
apex(data = mtcars, type = "scatter", mapping = aes(x = wt, y = mpg, z = scales::rescale(qsec)))
```




## Pie & donut charts

Simple pie charts can be created with:

```{r pie}
poll <- data.frame(
  answer = c("Yes", "No"),
  n = c(254, 238)
)

apex(data = poll, type = "pie", mapping = aes(x = answer, y = n))
```

It's also possible to make donut chart:

```{r donut}
apex(data = poll, type = "donut", mapping = aes(x = answer, y = n))
```



## Radial charts

Simple radial charts can be created with (here we pass values directly in `aes`, but you can use a `data.frame`) :

```{r radial}
apex(data = NULL, type = "radialBar", mapping = aes(x = "My value", y = 65))
```


Multi radial chart (more than one value):

```{r radial-mult}
fruits <- data.frame(
  name = c('Apples', 'Oranges', 'Bananas', 'Berries'),
  value = c(44, 55, 67, 83)
)

apex(data = fruits, type = "radialBar", mapping = aes(x = name, y = value))

```



## Radar charts

Simple radar charts can be created with:

```{r radar}
mtcars$model <- rownames(mtcars)

apex(data = head(mtcars), type = "radar", mapping = aes(x = model, y = qsec))
```

With a grouping variable:

```{r radar-mult}
# extremely complicated reshaping
new_mtcars <- reshape(
  data = head(mtcars), 
  idvar = "model", 
  varying = list(c("drat", "wt")),
  times = c("drat", "wt"),
  direction = "long",
  v.names = "value",
  drop = c("mpg", "cyl", "hp", "dist", "qsec", "vs", "am", "gear", "carb")
)

apex(data = new_mtcars, type = "radar", mapping = aes(x = model, y = value, group = time))
```


## Polar area

With some custom options for color mapping:

```{r polar-area}
apex(mtcars, aes(rownames(mtcars), mpg), type = "polarArea") %>% 
  ax_legend(show = FALSE) %>% 
  ax_colors(col_numeric("Blues", domain = NULL)(mtcars$mpg)) %>% 
  ax_fill(opacity = 1) %>% 
  ax_stroke(width = 0) %>% 
  ax_tooltip(fillSeriesColor = FALSE)
```


## Heatmap

Create a heatmap with : 

```{r heatmap}
# create some data
sales <- expand.grid(year = 2010:2020, month = month.name)
sales$value <- sample(-10:30, nrow(sales), TRUE)

apex(
  data = sales,
  type = "heatmap", 
  mapping = aes(x = year, y = month, fill = value)
) %>% 
  ax_dataLabels(enabled = FALSE) %>% 
  ax_colors("#008FFB")
```


## Treemap

Create a treemap with:

```{r treemap}
data("mpg", package = "ggplot2")

apex(mpg, aes(x = manufacturer), "treemap")
```


## Candlestick

Create a candlestick chart with:

```{r candlestick}
data("candles", package = "apexcharter")

apex(
  candles, 
  aes(x = datetime, open = open, close = close, low = low, high = high),
  type = "candlestick"
)
```



## Boxplot

Create boxplot (without outliers for now) with:

```{r boxplot}
data("mpg", package = "ggplot2")
apex(mpg, aes(hwy, class), "boxplot") %>% 
  ax_plotOptions(
    boxPlot = boxplot_opts(color.upper = "#8BB0A6", color.lower = "#8BB0A6" )
  ) %>% 
  ax_stroke(colors = list("#2A5769")) %>% 
  ax_grid(
    xaxis = list(lines = list(show = TRUE)),
    yaxis = list(lines = list(show = FALSE))
  )
```



## Dumbbell charts

Create Dumbbell chart with: 

```{r dumbbell}
data("life_expec", package = "apexcharter")

apex(life_expec, aes(country, x = `1972`, xend = `2007`), type = "dumbbell") %>% 
  ax_plotOptions(
    bar = bar_opts(
      dumbbellColors = list(list("#3d85c6", "#fb6003"))
    )
  ) %>% 
  ax_colors("#BABABA") %>% 
  ax_labs(
    title = "Life expectancy : 1972 vs. 2007",
    subtitle = "Data from Gapminder dataset",
    x = "Life expectancy at birth, in years"
  )
```