Package 'AutoPlots'

Title: Creating Echarts Visualizations as Easy as Possible
Description: Create beautiful and interactive visualizations in a single function call. The 'data.table' package is utilized to perform the data wrangling necessary to prepare your data for the plot types you wish to build, along with allowing fast processing for big data. There are two broad classes of plots available: standard plots and machine learning evaluation plots. There are lots of parameters available in each plot type function for customizing the plots (such as faceting) and data wrangling (such as variable transformations and aggregation).
Authors: Adrian Antico [aut, cre, cph]
Maintainer: Adrian Antico <[email protected]>
License: AGPL (>= 3)
Version: 1.5.2
Built: 2026-10-21 20:53:45 UTC
Source: https://github.com/adrianantico/autoplots

Help Index

ACF

Description

Build an autocorrelation plot by simply passing arguments to a single function

Usage

ACF(
  dt = NULL,
  YVar = NULL,
  DateVar = NULL,
  TimeUnit = NULL,
  MaxLags = 50,
  YVarTrans = "Identity",
  AggMethod = "sum",
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  title.text = "Autocorrelation Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
DateVar

Date column in data
TimeUnit

Select from "hour", "day", "week", "month", "quarter", "year"
MaxLags

Max lag values to test
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Ask CommunicationIntelligence for a plot request

Description

Build a pattern-inspection realization request through CommunicationIntelligence's public API. CommunicationIntelligence's text helpers do not call this function.

Usage

ap_bind_pattern_request(inputs, task_id = "autoplots-pattern")

Arguments

inputs

An admitted CommunicationIntelligence input set. This function does not invent owner values.
task_id

Task id used for the host request.

Value

A list. status = "REQUEST_READY" means request and task can be passed to ap_realize_request. That status is not a drawing status. release_authorized is FALSE.

Examples

## Not run: 
bound <- ap_bind_pattern_request(inputs, "figure-1")
figure <- ap_realize_request(bound$request, bound$task)

## End(Not run)

Draw an authenticated realization request

Description

Verify a realization request by replaying CommunicationIntelligence, then draw the admitted numbers. The PNG subtitle shows the unit, the source revision, and that the figure is not an approval. AutoPlots does not estimate, refit, approve, or authorize publication.

Usage

ap_realize_request(request, task, file = NULL, encoding = NULL,
  width = 800L, height = 500L, res = 96L)

Arguments

request

A CommunicationIntelligence RealizationRequest. A hash on a modified record is not accepted.
task

The TaskBinding named by the request.
file

PNG path. The default is a temporary file.
encoding

Optional rendering instruction. NULL is an identity column from zero, one panel per quantity. Fields that change the estimand are refused, except an authorized log10 point.
width, height

Device pixels, from 200 to 1200.
res

One of 72, 96, 120, or 144.

Details

The supported geoms are column, point, and interval. Interval ids are <stem>_lower, <stem>_upper, and an optional <stem> point. Without the point, the title is the admitted endpoint range, not either endpoint alone. Quantities that are not part of the interval are refused, as are endpoints that do not share a unit. A requested interval kind must already occur in the admitted uncertainty wording.

A log10 point requires a receipt with status = "MET" and subject_binding equal to the CommunicationIntelligence binding of list(scale = "log10", quantity_ids = <ids in plot order>, values = <admitted numbers in plot order>). Without that receipt the status is UNRESOLVED_AUTHORITY. The title keeps the admitted number. The axis label and subtitle say that the scale is log10.

Value

A list. status is RENDERED, REFUSED, or UNRESOLVED_AUTHORITY. release_authorized is always FALSE. A rendered file does not authorize publication. geometry is a data.table of admitted values, axis limits, and device coordinates for this PNG. Those coordinates are not a cross-machine pixel certificate.

Examples

refused <- ap_realize_request(NULL, NULL)
stopifnot(identical(refused$status, "REFUSED"))
stopifnot(isFALSE(refused$release_authorized))

Area

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Area(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Smooth = TRUE,
  ShowSymbol = FALSE,
  areaStyle.color = NULL,
  areaStyle.opacity = NULL,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = "Area Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = 12,
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = NULL,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Smooth

= TRUE
ShowSymbol

= FALSE
areaStyle.color

Fill color
areaStyle.opacity

transparency
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build plot
AutoPlots::Area(
  dt = data,
  PreAgg = TRUE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "Identity",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "Identity",
  GroupVar = NULL,
  Theme = "macarons")

Bar

Description

Build a bar plot by simply passing arguments to a single function

Usage

Bar(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  LabelValues = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  backgroundStyle.color = NULL,
  backgroundStyle.opacity = NULL,
  title.text = "Bar Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
LabelValues

A vector of values. Requires PreAgg to be set to TRUE and you'll need to ensure LabelValues are ordered the same as dt. If NULL and ShowLabels is TRUE, then bar values will be displayed
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
ShowLabels

logical
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
backgroundStyle.color

vector of colors
backgroundStyle.opacity

vector of opacities
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 10000)

# Echarts Bar Chart
AutoPlots::Bar(
  dt = data,
  PreAgg = TRUE,
  XVar = "Factor_1",
  YVar = "Adrian",
  GroupVar = NULL,
  LabelValues = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,

  Debug = FALSE)

BarPlot3D

Description

Build a 3D Bar Plot

Usage

BarPlot3D(
  dt,
  PreAgg = TRUE,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  title.text = "3D Bar Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical. Is your data pre aggregated
AggMethod

'mean', 'median', 'sum', 'sd', 'coeffvar', 'count'
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_Y

= 20
NumLevels_X

= 20
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 10000)

# Echarts 3D Bar Chart
AutoPlots::BarPlot3D(
  dt = data,
  PreAgg = TRUE,
  AggMethod = 'mean',
  XVar = "Factor_1",
  YVar = "Factor_2",
  ZVar = "Adrian",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,

  Debug = FALSE)

BinaryMetricsPlot

Description

Line plot of evaluation metrics across thresholds

Usage

BinaryMetricsPlot(
  dt = NULL,
  PreAgg = TRUE,
  AggMethod = "mean",
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  Metrics = c("Utility", "MCC", "Accuracy", "F1_Score", "F2_Score", "F0.5_Score",
    "ThreatScore", "TPR", "TNR", "FNR", "FPR", "FDR", "FOR"),
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  CostMatrixWeights = c(0, 1, 1, 0),
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  MouseScroll = FALSE,
  ShowLabels = FALSE,
  Theme = "dark",
  EchartsLabels = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
Metrics

Multiple selection "Utility","MCC","Accuracy","F1_Score","F2_Score","F0.5_Score","ThreatScore","TPR","TNR","FNR","FPR","FDR","FOR"
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
CostMatrixWeights

vector length 4. FP, FP, FN, TP
NumberBins

numeric
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
EchartsLabels

character
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Box

Description

Build a box plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Box(
  dt = NULL,
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  itemStyle.color = NULL,
  itemStyle.opacity = NULL,
  itemStyle.borderColor = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.borderType = NULL,
  itemStyle.borderCap = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.shadowOffsetY = NULL,
  title.text = "BoxPlot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
itemStyle.color

Fill color. Can be a single color or vector of multiple colors for gradient.
itemStyle.opacity

transparency
itemStyle.borderColor

hex or color name
itemStyle.borderWidth

numeric
itemStyle.borderType

'solid' 'dashed' 'dotted'
itemStyle.borderCap

'butt' 'round' 'square'
itemStyle.shadowBlur

numeric
itemStyle.shadowColor

hex or name
itemStyle.shadowOffsetX

numeric
itemStyle.shadowOffsetY

numeric
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)), GV = sample(LETTERS, 1000, TRUE))

AutoPlots::Box(
  dt = dt,
  SampleSize = 100000L,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,

  Debug = FALSE)

Calibration.Box

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Calibration.Box(
  dt = NULL,
  SampleSize = 100000L,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  Height = NULL,
  Width = NULL,
  MouseScroll = FALSE,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
AggMethod

character
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Calibration.Line

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Calibration.Line(
  dt = NULL,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  MouseScroll = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

logical
MouseScroll

logical, zoom via mouse scroll
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

ConfusionMatrix

Description

Generate variable importance plots

Usage

ConfusionMatrix(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_X = 50,
  NumLevels_Y = 50,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  AggMethod = "count",
  GroupVar = NULL,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

FALSE
XVar

Column name of X-Axis variable. If NULL then ignored
YVar

Column name of Y-Axis variable. If NULL then ignored
ZVar

= "N"
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21,
NumLevels_X

= NumLevels_Y,
NumLevels_Y

= NumLevels_X,
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
GroupVar

= NULL
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Copula

Description

Build a copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Copula(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = "Copula Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Requires an XVar and YVar already be defined
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
AddGLM

logical
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland",
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts Copula Plot Chart
AutoPlots::Copula(
  dt = data,
  SampleSize = 10000,
  XVar = "Independent_Variable8",
  YVar = "Adrian",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,

  Debug = FALSE)

Copula3D

Description

Build a 3D-copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Copula3D(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark-blue",
  TimeLine = FALSE,
  title.text = "3D Copula Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
GroupVar

Requires an XVar and YVar already be defined
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

Logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable9 := Independent_Variable9 * runif(.N)]

# Echarts Copula Plot Chart
AutoPlots::Copula3D(
  dt = data,
  SampleSize = 10000,
  XVar = "Adrian",
  YVar = "Independent_Variable9",
  ZVar = "Independent_Variable6",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,

  Debug = FALSE)

CorrMatrix

Description

Build a correlation matrix plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

CorrMatrix(
  dt = NULL,
  CorrVars = NULL,
  CorrVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Method = "spearman",
  PreAgg = TRUE,
  MaxNAPercent = 0.05,
  Height = NULL,
  Width = NULL,
  ShowLabels = TRUE,
  Theme = "dark",
  MouseScroll = FALSE,
  visualMap.show = TRUE,
  visualMap.min = -1,
  visualMap.max = 1,
  visualMap.orient = "vertical",
  visualMap.right = "2%",
  visualMap.top = "middle",
  visualMap.bottom = NULL,
  visualMap.left = NULL,
  visualMap.backgroundColor = NULL,
  visualMap.borderColor = NULL,
  visualMap.borderWidth = NULL,
  visualMap.InRange.color = NULL,
  visualMap.InRange.opacity = NULL,
  visualMap.InRange.symbol = NULL,
  visualMap.InRange.symbolSize = NULL,
  title.text = "Correlogram",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
CorrVars

vector of variable names
CorrVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Method

character
PreAgg

logical
MaxNAPercent

numeric
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
visualMap.show

TRUE
visualMap.min

min value
visualMap.max

max value
visualMap.orient

'vertical' 'horizontal'
visualMap.right

number
visualMap.top

number
visualMap.bottom

number
visualMap.left

number
visualMap.backgroundColor

hex or name
visualMap.borderColor

hex or name
visualMap.borderWidth

number
visualMap.InRange.color

hex or name
visualMap.InRange.opacity

number
visualMap.InRange.symbol

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
visualMap.InRange.symbolSize

number
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts CorrMatrix Plot Chart
AutoPlots::CorrMatrix(
  dt = data,
  PreAgg = FALSE,
  CorrVars = c(
    "Adrian",
    "Independent_Variable1",
    "Independent_Variable2",
    "Independent_Variable3",
    "Independent_Variable4",
    "Independent_Variable5"),
  CorrVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Method = 'pearson',
  MaxNAPercent = 0.05,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  Debug = FALSE)

Density

Description

Density plots, by groups, with transparent continuous plots

Usage

Density(
  dt = NULL,
  SampleSize = 100000L,
  XVar = NULL,
  XVarTrans = "Identity",
  GroupVar = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  TimeLine = FALSE,
  showSymbol = FALSE,
  areaStyle.color = NULL,
  areaStyle.opacity = NULL,
  Height = NULL,
  Width = NULL,
  MouseScroll = FALSE,
  ShowLabels = FALSE,
  Theme = "dark",
  title.text = "Density Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

= 100000L
XVar

X-Axis variable name
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
GroupVar

Character variable
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
TimeLine

logical
showSymbol

logical
areaStyle.color

color or hex
areaStyle.opacity

numeric
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)))

# Create plot
AutoPlots::Density(
  dt = dt,
  SampleSize = 30000L,
  XVar = "Y",
  GroupVar = NULL,
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  Debug = FALSE)

Display a Series of Plots in a Styled HTML Grid

Description

Arrange a list of echarts4r/htmlwidgets plots into a styled HTML grid. Supports optional card titles, subtitles, responsive layouts, last-row behavior, HTML export, and optional code generation.

Usage

display_plots_grid(
  plots,
  cols = NULL,
  titles = NULL,
  subtitles = NULL,
  gap = "20px",
  padding = "0px",
  min_width = "350px",
  last_row = c("span", "left", "center", "none"),
  card = TRUE,
  card_background = NULL,
  card_border = NULL,
  card_radius = "14px",
  card_padding = "14px",
  card_shadow = NULL,
  title_color = NULL,
  subtitle_color = NULL,
  title_size = "16px",
  subtitle_size = "13px",
  font_family = "Segoe UI, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
  container_class = "plot-card",
  grid_class = "plot-grid",
  background = NULL,
  width = "100%",
  resizable = TRUE,
  row_height = "420px",
  row_min_height = "320px",
  save_path = NULL,
  selfcontained = TRUE,
  return_code = FALSE
)

Arguments

plots

A list of echarts4r plots, htmlwidgets, or htmltools tags.
cols

Number of grid columns. Use NULL for auto-fit responsive layout.
titles

Optional character vector of card titles, one per plot.
subtitles

Optional character vector of card subtitles, one per plot.
gap

CSS grid gap.
padding

CSS padding around the full grid.
min_width

Minimum card width when cols = NULL.
last_row

Behavior when explicit cols leaves one plot in last row. One of "span", "left", "center", or "none".
card

Logical. If TRUE, wrap each plot in a styled card.
card_background

CSS background for cards.
card_border

CSS border for cards.
card_radius

CSS border-radius for cards.
card_padding

CSS padding inside cards.
card_shadow

CSS box-shadow for cards.
title_color

CSS color for card titles.
subtitle_color

CSS color for card subtitles.
title_size

CSS font-size for card titles.
subtitle_size

CSS font-size for card subtitles.
font_family

CSS font-family used for titles/subtitles.
container_class

CSS class for each plot container.
grid_class

CSS class for the grid layout container.
background

Optional CSS background for the full grid wrapper.
width

CSS width of the full grid wrapper.
resizable

Logical. If TRUE and 'cols' is explicit, plots are grouped into vertically resizable rows and widgets fill the available row height.
row_height

Default CSS height for resizable rows. May be length 1 or one value per generated row.
row_min_height

Minimum CSS height for resizable rows. May be length 1 or one value per generated row.
save_path

Optional file path to save standalone HTML.
selfcontained

Logical passed to htmlwidgets::saveWidget.
return_code

Logical. If TRUE, return list(html = ..., code = ...).

Value

A browsable HTML grid, or list(html, code) when return_code = TRUE.

Display Plots in Styled Sections

Description

Arrange plots into named report-style sections. Each section uses display_plots_grid() internally.

Usage

display_plots_sections(
  sections,
  cols = 2,
  collapsible = TRUE,
  open = TRUE,
  section_titles = NULL,
  section_subtitles = NULL,
  plot_titles = NULL,
  plot_subtitles = NULL,
  gap = "20px",
  section_gap = "22px",
  padding = "0px",
  card = TRUE,
  card_background = NULL,
  card_border = NULL,
  card_shadow = NULL,
  section_background = NULL,
  section_border = NULL,
  section_radius = "16px",
  section_padding = "18px",
  title_color = NULL,
  subtitle_color = NULL,
  font_family = "Segoe UI, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
  resizable = TRUE,
  row_height = "420px",
  row_min_height = "320px",
  save_path = NULL,
  selfcontained = TRUE,
  return_code = FALSE
)

Arguments

sections

A named list. Each element should be a list of plots.
cols

Number of columns per section.
collapsible

Logical. If TRUE, sections use HTML details/summary.
open

Logical. If TRUE, collapsible sections are open by default.
section_titles

Optional section titles. Defaults to names(sections).
section_subtitles

Optional section subtitles.
plot_titles

Optional named list of title vectors by section.
plot_subtitles

Optional named list of subtitle vectors by section.
gap

CSS grid gap inside sections.
section_gap

CSS gap between sections.
padding

CSS padding around the full report.
card

Logical. If TRUE, wrap plots in cards.
card_background

CSS background for plot cards. Defaults to inferred theme.
card_border

CSS border for plot cards. Defaults to inferred theme.
card_shadow

CSS box-shadow for plot cards. Defaults to inferred theme.
section_background

CSS background for section wrappers.
section_border

CSS border for section wrappers.
section_radius

CSS border-radius for section wrappers.
section_padding

CSS padding for section wrappers.
title_color

CSS color for section titles.
subtitle_color

CSS color for section subtitles.
font_family

CSS font-family.
resizable

Logical. If TRUE, each section's grid is grouped into vertically resizable rows by 'cols'.
row_height

Default CSS height for resizable rows. May be length 1 or one value per generated row inside each section.
row_min_height

Minimum CSS height for resizable rows. May be length 1 or one value per generated row inside each section.
save_path

Optional file path to save standalone HTML.
selfcontained

Logical passed to htmlwidgets::saveWidget.
return_code

Logical. If TRUE, return list(html = ..., code = ...).

Value

A browsable sectioned HTML report, or list(html, code) when return_code = TRUE.

Display Plots in HTML Tabs

Description

Arrange a list of plots into a tabbed HTML interface.

Usage

display_plots_tabs(
  plots,
  tab_titles = NULL,
  titles = NULL,
  subtitles = NULL,
  selected = 1L,
  card = TRUE,
  card_background = NULL,
  card_border = NULL,
  card_radius = "14px",
  card_padding = "14px",
  card_shadow = NULL,
  title_color = NULL,
  subtitle_color = NULL,
  title_size = "16px",
  subtitle_size = "13px",
  font_family = "Segoe UI, system-ui, -apple-system, BlinkMacSystemFont, sans-serif",
  tabs_class = "plot-tabs",
  save_path = NULL,
  selfcontained = TRUE,
  return_code = FALSE
)

Arguments

plots

A list of echarts4r plots, htmlwidgets, or htmltools tags.
tab_titles

Optional tab labels. If NULL, names(plots) are used when available.
titles

Optional card titles, one per plot.
subtitles

Optional card subtitles, one per plot.
selected

Initial selected tab index.
card

Logical. If TRUE, wrap each plot in a styled card.
card_background

CSS background for cards.
card_border

CSS border for cards.
card_radius

CSS border-radius for cards.
card_padding

CSS padding inside cards.
card_shadow

CSS box-shadow for cards.
title_color

CSS color for card titles.
subtitle_color

CSS color for card subtitles.
title_size

CSS font-size for card titles.
subtitle_size

CSS font-size for card subtitles.
font_family

CSS font-family.
tabs_class

CSS class for wrapper.
save_path

Optional file path to save standalone HTML.
selfcontained

Logical passed to htmlwidgets::saveWidget.
return_code

Logical. If TRUE, return list(html = ..., code = ...).

Value

A browsable HTML tab set, or list(html, code) when return_code = TRUE.

Donut

Description

Build a donut plot by simply passing arguments to a single function

Usage

Donut(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = TRUE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = "Donut Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "item",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Donut(
  dt = dt,
  PreAgg = TRUE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  Debug = FALSE)

Enhanced area Setter for echarts4r

Description

Exposes every area* option so you don't have to hand-craft the JSON.

Usage

e_area_full(
  e = NULL,
  serie = NULL,
  smooth = NULL,
  showSymbol = NULL,
  areaStyle.color = NULL,
  areaStyle.opacity = NULL
)

Arguments

e

plot object
serie

Variable
smooth

Smooth line
showSymbol

Logical
areaStyle.color

Fill color. Can be a single color or vector of multiple colors for gradient.
areaStyle.opacity

transparency

Value

The modified echarts4r object

Enhanced area Setter for echarts4r

Description

Exposes every area* option so you don't have to hand-craft the JSON.

Usage

e_bar_full(
  e = NULL,
  serie = NULL,
  label = FALSE,
  backgroundStyle.color = NULL,
  backgroundStyle.opacity = NULL
)

Arguments

e

plot object
serie

Variable
label

Logical
backgroundStyle.color

Fill color. Can be a single color or vector of multiple colors for gradient.
backgroundStyle.opacity

transparency

Value

The modified echarts4r object

Enhanced area Setter for echarts4r

Description

Exposes every area* option so you don't have to hand-craft the JSON.

Usage

e_boxplot_full(
  e = NULL,
  serie = NULL,
  label = FALSE,
  itemStyle.color = NULL,
  itemStyle.opacity = NULL,
  itemStyle.borderColor = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.borderType = NULL,
  itemStyle.borderCap = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.shadowOffsetY = NULL
)

Arguments

e

plot object
serie

Variable
label

Logical
itemStyle.color

Fill color. Can be a single color or vector of multiple colors for gradient.
itemStyle.opacity

transparency
itemStyle.borderColor

hex or color name
itemStyle.borderWidth

numeric
itemStyle.borderType

'solid' 'dashed' 'dotted'
itemStyle.borderCap

'butt' 'round' 'square'
itemStyle.shadowBlur

numeric
itemStyle.shadowColor

hex or name
itemStyle.shadowOffsetX

numeric
itemStyle.shadowOffsetY

numeric

Value

The modified echarts4r object

Enhanced DataZoom Slider Setter for echarts4r

Description

Exposes dataZoom-slider.* options so you don't have to hand-craft the JSON.

Usage

e_data_zoom_slider_full(
  e,
  index = NULL,
  dataZoom.id = NULL,
  dataZoom.show = TRUE,
  dataZoom.backgroundColor = NULL,
  dataZoom.fillerColor = NULL,
  dataZoom.borderColor = NULL,
  dataZoom.borderRadius = NULL,
  dataZoom.handleIcon = NULL,
  dataZoom.handleSize = NULL,
  dataZoom.handleLabel.show = NULL,
  dataZoom.moveHandleIcon = NULL,
  dataZoom.moveHandleSize = NULL,
  dataZoom.labelPrecision = NULL,
  dataZoom.labelFormatter = NULL,
  dataZoom.showDetail = NULL,
  dataZoom.showDataShadow = NULL,
  dataZoom.realtime = NULL,
  dataZoom.xAxisIndex = 0,
  dataZoom.yAxisIndex = NULL,
  dataZoom.radiusAxisIndex = NULL,
  dataZoom.angleAxisIndex = NULL,
  dataZoom.filterMode = NULL,
  dataZoom.start = NULL,
  dataZoom.end = NULL,
  dataZoom.startValue = NULL,
  dataZoom.endValue = NULL,
  dataZoom.minSpan = NULL,
  dataZoom.maxSpan = NULL,
  dataZoom.minValueSpan = NULL,
  dataZoom.maxValueSpan = NULL,
  dataZoom.orient = "horizontal",
  dataZoom.zoomLock = NULL,
  dataZoom.throttle = NULL,
  dataZoom.rangeMode = NULL,
  dataZoom.zlevel = NULL,
  dataZoom.z = NULL,
  dataZoom.left = NULL,
  dataZoom.top = NULL,
  dataZoom.right = NULL,
  dataZoom.bottom = NULL,
  dataZoom.width = NULL,
  dataZoom.height = NULL,
  dataZoom.brushSelect = NULL,
  dataZoom.dataBackground.lineStyle.color = NULL,
  dataZoom.dataBackground.lineStyle.width = NULL,
  dataZoom.dataBackground.lineStyle.type = NULL,
  dataZoom.dataBackground.lineStyle.dashOffset = NULL,
  dataZoom.dataBackground.lineStyle.cap = NULL,
  dataZoom.dataBackground.lineStyle.join = NULL,
  dataZoom.dataBackground.lineStyle.miterLimit = NULL,
  dataZoom.dataBackground.lineStyle.shadowBlur = NULL,
  dataZoom.dataBackground.lineStyle.shadowColor = NULL,
  dataZoom.dataBackground.lineStyle.shadowOffsetX = NULL,
  dataZoom.dataBackground.lineStyle.shadowOffsetY = NULL,
  dataZoom.dataBackground.lineStyle.opacity = NULL,
  dataZoom.dataBackground.areaStyle.color = NULL,
  dataZoom.dataBackground.areaStyle.shadowBlur = NULL,
  dataZoom.dataBackground.areaStyle.shadowColor = NULL,
  dataZoom.dataBackground.areaStyle.shadowOffsetX = NULL,
  dataZoom.dataBackground.areaStyle.shadowOffsetY = NULL,
  dataZoom.dataBackground.areaStyle.opacity = NULL,
  dataZoom.selectedDataBackground.lineStyle.color = NULL,
  dataZoom.selectedDataBackground.lineStyle.width = NULL,
  dataZoom.selectedDataBackground.lineStyle.type = NULL,
  dataZoom.selectedDataBackground.lineStyle.dashOffset = NULL,
  dataZoom.selectedDataBackground.lineStyle.cap = NULL,
  dataZoom.selectedDataBackground.lineStyle.join = NULL,
  dataZoom.selectedDataBackground.lineStyle.miterLimit = NULL,
  dataZoom.selectedDataBackground.lineStyle.shadowBlur = NULL,
  dataZoom.selectedDataBackground.lineStyle.shadowColor = NULL,
  dataZoom.selectedDataBackground.lineStyle.shadowOffsetX = NULL,
  dataZoom.selectedDataBackground.lineStyle.shadowOffsetY = NULL,
  dataZoom.selectedDataBackground.lineStyle.opacity = NULL,
  dataZoom.selectedDataBackground.areaStyle.color = NULL,
  dataZoom.selectedDataBackground.areaStyle.shadowBlur = NULL,
  dataZoom.selectedDataBackground.areaStyle.shadowColor = NULL,
  dataZoom.selectedDataBackground.areaStyle.shadowOffsetX = NULL,
  dataZoom.selectedDataBackground.areaStyle.shadowOffsetY = NULL,
  dataZoom.selectedDataBackground.areaStyle.opacity = NULL,
  dataZoom.handleStyle.color = NULL,
  dataZoom.handleStyle.borderColor = NULL,
  dataZoom.handleStyle.borderWidth = NULL,
  dataZoom.handleStyle.borderType = NULL,
  dataZoom.handleStyle.borderDashOffset = NULL,
  dataZoom.handleStyle.borderCap = NULL,
  dataZoom.handleStyle.borderJoin = NULL,
  dataZoom.handleStyle.borderMiterLimit = NULL,
  dataZoom.handleStyle.shadowBlur = NULL,
  dataZoom.handleStyle.shadowColor = NULL,
  dataZoom.handleStyle.shadowOffsetX = NULL,
  dataZoom.handleStyle.shadowOffsetY = NULL,
  dataZoom.handleStyle.opacity = NULL,
  dataZoom.moveHandleStyle.color = NULL,
  dataZoom.moveHandleStyle.borderColor = NULL,
  dataZoom.moveHandleStyle.borderWidth = NULL,
  dataZoom.moveHandleStyle.borderType = NULL,
  dataZoom.moveHandleStyle.borderDashOffset = NULL,
  dataZoom.moveHandleStyle.borderCap = NULL,
  dataZoom.moveHandleStyle.borderJoin = NULL,
  dataZoom.moveHandleStyle.borderMiterLimit = NULL,
  dataZoom.moveHandleStyle.shadowBlur = NULL,
  dataZoom.moveHandleStyle.shadowColor = NULL,
  dataZoom.moveHandleStyle.shadowOffsetX = NULL,
  dataZoom.moveHandleStyle.shadowOffsetY = NULL,
  dataZoom.moveHandleStyle.opacity = NULL,
  dataZoom.textStyle.color = NULL,
  dataZoom.textStyle.fontStyle = NULL,
  dataZoom.textStyle.fontWeight = NULL,
  dataZoom.textStyle.fontFamily = NULL,
  dataZoom.textStyle.fontSize = NULL,
  dataZoom.textStyle.lineHeight = NULL,
  dataZoom.textStyle.width = NULL,
  dataZoom.textStyle.height = NULL,
  dataZoom.textStyle.textBorderColor = NULL,
  dataZoom.textStyle.textBorderWidth = NULL,
  dataZoom.textStyle.textBorderType = NULL,
  dataZoom.textStyle.textBorderDashOffset = NULL,
  dataZoom.textStyle.textShadowColor = NULL,
  dataZoom.textStyle.textShadowBlur = NULL,
  dataZoom.textStyle.textShadowOffsetX = NULL,
  dataZoom.textStyle.textShadowOffsetY = NULL,
  dataZoom.textStyle.overflow = NULL,
  dataZoom.textStyle.ellipsis = NULL,
  dataZoom.brushStyle.color = NULL,
  dataZoom.brushStyle.borderColor = NULL,
  dataZoom.brushStyle.borderWidth = NULL,
  dataZoom.brushStyle.borderType = NULL,
  dataZoom.brushStyle.borderDashOffset = NULL,
  dataZoom.brushStyle.borderCap = NULL,
  dataZoom.brushStyle.borderJoin = NULL,
  dataZoom.brushStyle.borderMiterLimit = NULL,
  dataZoom.brushStyle.shadowBlur = NULL,
  dataZoom.brushStyle.shadowColor = NULL,
  dataZoom.brushStyle.shadowOffsetX = NULL,
  dataZoom.brushStyle.shadowOffsetY = NULL,
  dataZoom.brushStyle.opacity = NULL,
  dataZoom.emphasis.handleStyle.color = NULL,
  dataZoom.emphasis.handleStyle.borderColor = NULL,
  dataZoom.emphasis.handleStyle.borderWidth = NULL,
  dataZoom.emphasis.handleStyle.borderType = NULL,
  dataZoom.emphasis.handleStyle.opacity = NULL,
  dataZoom.emphasis.handleLabel.show = NULL,
  dataZoom.emphasis.moveHandleStyle.color = NULL,
  dataZoom.emphasis.moveHandleStyle.borderColor = NULL,
  dataZoom.emphasis.moveHandleStyle.borderWidth = NULL,
  dataZoom.emphasis.moveHandleStyle.borderType = NULL,
  dataZoom.emphasis.moveHandleStyle.opacity = NULL
)

Arguments

e

An echarts4r object
index

Which dataZoom component to target, zero-based. If NULL, append new slider.
dataZoom.id

Component ID
dataZoom.show

Whether to show the slider
dataZoom.backgroundColor

Background color
dataZoom.fillerColor

Color to fill selected area
dataZoom.borderColor

Border color
dataZoom.borderRadius

Border radius, numeric or array
dataZoom.handleIcon

Handle icon path/image
dataZoom.handleSize

Handle size
dataZoom.handleLabel.show

Whether to show handle label
dataZoom.moveHandleIcon

Move handle icon path/image
dataZoom.moveHandleSize

Move handle size
dataZoom.labelPrecision

Label precision, numeric or 'auto'
dataZoom.labelFormatter

Label formatter, string or JS function
dataZoom.showDetail

Whether to show detail while dragging
dataZoom.showDataShadow

Whether to show data shadow
dataZoom.realtime

Whether to update view while dragging
dataZoom.xAxisIndex

xAxis index or array of indices controlled by this slider
dataZoom.yAxisIndex

yAxis index or array of indices controlled by this slider
dataZoom.radiusAxisIndex

radiusAxis index or array of indices
dataZoom.angleAxisIndex

angleAxis index or array of indices
dataZoom.filterMode

'filter', 'weakFilter', 'empty', 'none'
dataZoom.start

Start percentage, 0 to 100
dataZoom.end

End percentage, 0 to 100
dataZoom.startValue

Start absolute value
dataZoom.endValue

End absolute value
dataZoom.minSpan

Minimum window size in percent
dataZoom.maxSpan

Maximum window size in percent
dataZoom.minValueSpan

Minimum window size in value units
dataZoom.maxValueSpan

Maximum window size in value units
dataZoom.orient

'horizontal' or 'vertical'
dataZoom.zoomLock

Whether to lock window size
dataZoom.throttle

Refresh throttle in milliseconds
dataZoom.rangeMode

Array such as c('value', 'percent')
dataZoom.zlevel

Canvas layer zlevel
dataZoom.z

Draw order z
dataZoom.left

Left position
dataZoom.top

Top position
dataZoom.right

Right position
dataZoom.bottom

Bottom position
dataZoom.width

Width
dataZoom.height

Height
dataZoom.brushSelect

Whether to enable brush selection
dataZoom.dataBackground.lineStyle.color

Data shadow line color
dataZoom.dataBackground.lineStyle.width

Data shadow line width
dataZoom.dataBackground.lineStyle.type

Data shadow line type
dataZoom.dataBackground.areaStyle.color

Data shadow area color
dataZoom.selectedDataBackground.lineStyle.color

Selected shadow line color
dataZoom.selectedDataBackground.lineStyle.width

Selected shadow line width
dataZoom.selectedDataBackground.lineStyle.type

Selected shadow line type
dataZoom.selectedDataBackground.areaStyle.color

Selected shadow area color
dataZoom.handleStyle.color

Handle color
dataZoom.handleStyle.borderColor

Handle border color
dataZoom.handleStyle.borderWidth

Handle border width
dataZoom.handleStyle.borderType

Handle border type
dataZoom.handleStyle.shadowBlur

Handle shadow blur
dataZoom.handleStyle.shadowColor

Handle shadow color
dataZoom.handleStyle.shadowOffsetX

Handle shadow X offset
dataZoom.handleStyle.shadowOffsetY

Handle shadow Y offset
dataZoom.handleStyle.opacity

Handle opacity
dataZoom.moveHandleStyle.color

Move handle color
dataZoom.moveHandleStyle.borderColor

Move handle border color
dataZoom.moveHandleStyle.borderWidth

Move handle border width
dataZoom.moveHandleStyle.borderType

Move handle border type
dataZoom.moveHandleStyle.opacity

Move handle opacity
dataZoom.textStyle.color

Text color
dataZoom.textStyle.fontStyle

Text font style
dataZoom.textStyle.fontWeight

Text font weight
dataZoom.textStyle.fontFamily

Text font family
dataZoom.textStyle.fontSize

Text font size
dataZoom.textStyle.lineHeight

Text line height
dataZoom.textStyle.width

Text block width
dataZoom.textStyle.height

Text block height
dataZoom.textStyle.overflow

Text overflow mode
dataZoom.textStyle.ellipsis

Text ellipsis
dataZoom.brushStyle.color

Brush color
dataZoom.brushStyle.borderColor

Brush border color
dataZoom.brushStyle.borderWidth

Brush border width
dataZoom.brushStyle.borderType

Brush border type
dataZoom.brushStyle.opacity

Brush opacity

Value

The modified echarts4r object

Enhanced area Setter for echarts4r

Description

Exposes every area* option so you don't have to hand-craft the JSON.

Usage

e_density_full(
  e = NULL,
  serie = NULL,
  smooth = NULL,
  showSymbol = NULL,
  areaStyle.color = NULL,
  areaStyle.opacity = NULL
)

Arguments

e

plot object
serie

Variable
smooth

Smooth line
showSymbol

Logical
areaStyle.color

Fill color. Can be a single color or vector of multiple colors for gradient.
areaStyle.opacity

transparency

Value

The modified echarts4r object

grid function

Description

exposed parameters for grid. Use to control plot margins/size so long axis labels don't get truncated.

Usage

e_grid_full(
  e = NULL,
  grid.show = NULL,
  grid.left = NULL,
  grid.top = NULL,
  grid.right = NULL,
  grid.bottom = NULL,
  grid.width = NULL,
  grid.height = NULL,
  grid.containLabel = NULL,
  grid.backgroundColor = NULL,
  grid.borderColor = NULL,
  grid.borderWidth = NULL,
  grid.shadowBlur = NULL,
  grid.shadowColor = NULL,
  grid.shadowOffsetX = NULL,
  grid.shadowOffsetY = NULL,
  grid.z = NULL,
  grid.zlevel = NULL,
  grid.silent = NULL
)

Arguments

e

existing plot
grid.show

logical
grid.left

numeric or character px or percent
grid.top

numeric or character
grid.right

numeric or character
grid.bottom

numeric or character
grid.width

numeric or character
grid.height

numeric or character
grid.containLabel

logical (TRUE leaves space for axis labels)
grid.backgroundColor

hex or named color
grid.borderColor

hex or named color
grid.borderWidth

numeric
grid.shadowBlur

numeric
grid.shadowColor

hex or named color
grid.shadowOffsetX

numeric
grid.shadowOffsetY

numeric
grid.z

numeric
grid.zlevel

numeric
grid.silent

logical

Value

The modified echarts4r object

Heatmap customization

Description

Expose most heatmap options

Usage

e_heatmap_full(
  e,
  y,
  z,
  itemStyle.borderColor = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowOffsetY = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.opacity = NULL,
  itemStyle.borderRadius = NULL,
  emphasis.shadowColor = NULL,
  emphasis.shadowBlur = NULL,
  itemStyle.emphasis.label.show = NULL,
  itemStyle.emphasis.label.color = NULL,
  itemStyle.emphasis.label.fontStyle = NULL,
  itemStyle.emphasis.label.fontWeight = NULL,
  itemStyle.emphasis.label.fontFamily = NULL,
  itemStyle.emphasis.label.fontSize = NULL,
  itemStyle.emphasis.label.align = NULL,
  itemStyle.emphasis.label.verticalAlign = NULL,
  itemStyle.emphasis.label.backgroundColor = NULL,
  itemStyle.emphasis.label.borderColor = NULL,
  itemStyle.emphasis.label.borderWidth = NULL,
  itemStyle.emphasis.label.borderType = NULL,
  itemStyle.emphasis.label.borderRadius = NULL,
  itemStyle.emphasis.label.shadowColor = NULL,
  itemStyle.emphasis.label.shadowBlur = NULL,
  itemStyle.emphasis.label.shadowOffsetY = NULL,
  itemStyle.emphasis.label.shadowOffsetX = NULL,
  itemStyle.emphasis.label.width = NULL,
  itemStyle.emphasis.label.height = NULL,
  itemStyle.emphasis.label.textBorderColor = NULL,
  itemStyle.emphasis.label.textBorderWidth = NULL,
  itemStyle.emphasis.label.textShadowColor = NULL,
  itemStyle.emphasis.label.textShadowBlur = NULL,
  itemStyle.emphasis.label.textShadowOffsetY = NULL,
  itemStyle.emphasis.label.textShadowOffsetX = NULL,
  label.show = NULL,
  label.color = NULL,
  label.fontStyle = NULL,
  label.fontWeight = NULL,
  label.fontFamily = NULL,
  label.fontSize = NULL,
  label.align = NULL,
  label.verticalAlign = NULL,
  label.backgroundColor = NULL,
  label.borderColor = NULL,
  label.borderWidth = NULL,
  label.borderType = NULL,
  label.borderRadius = NULL,
  label.shadowColor = NULL,
  label.shadowBlur = NULL,
  label.shadowOffsetY = NULL,
  label.shadowOffsetX = NULL,
  label.width = NULL,
  label.height = NULL,
  label.textBorderColor = NULL,
  label.textBorderWidth = NULL,
  label.textShadowColor = NULL,
  label.textShadowBlur = NULL,
  label.textShadowOffsetY = NULL,
  label.textShadowOffsetX = NULL
)

Arguments

e

existing plot variable
y

YVar
z

ZVar
itemStyle.borderColor

hex or name
itemStyle.borderWidth

number
itemStyle.shadowColor

hex or name
itemStyle.shadowBlur

number
itemStyle.shadowOffsetY

number
itemStyle.shadowOffsetX

number
itemStyle.opacity

decimal
itemStyle.borderRadius

number
emphasis.shadowColor

hex or name
emphasis.shadowBlur

number
itemStyle.emphasis.label.show

logical
itemStyle.emphasis.label.color

hex or name
itemStyle.emphasis.label.fontStyle

'normal' 'italic' 'oblique'
itemStyle.emphasis.label.fontWeight

'normal' 'bold' 'bolder' 'lighter'
itemStyle.emphasis.label.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
itemStyle.emphasis.label.fontSize

number
itemStyle.emphasis.label.align

'left' 'center' 'right'
itemStyle.emphasis.label.verticalAlign

'top' 'middle' 'bottom'
itemStyle.emphasis.label.backgroundColor

hex or name
itemStyle.emphasis.label.borderColor

hex or name
itemStyle.emphasis.label.borderWidth

number
itemStyle.emphasis.label.borderType

'solid' 'dashed' 'dotted'
itemStyle.emphasis.label.borderRadius

number
itemStyle.emphasis.label.shadowColor

hex or name
itemStyle.emphasis.label.shadowBlur

number
itemStyle.emphasis.label.shadowOffsetY

number
itemStyle.emphasis.label.shadowOffsetX

number
itemStyle.emphasis.label.width

number
itemStyle.emphasis.label.height

number
itemStyle.emphasis.label.textBorderColor

hex or name
itemStyle.emphasis.label.textBorderWidth

number
itemStyle.emphasis.label.textShadowColor

hex or name
itemStyle.emphasis.label.textShadowBlur

number
itemStyle.emphasis.label.textShadowOffsetY

number
itemStyle.emphasis.label.textShadowOffsetX

number
label.show

logical
label.color

hex or name
label.fontStyle

'normal' 'italic' 'oblique'
label.fontWeight

'normal' 'bold' 'bolder' 'lighter'
label.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
label.fontSize

number
label.align

'left' 'center' 'right'
label.verticalAlign

'top' 'middle' 'bottom'
label.backgroundColor

hex or name
label.borderColor

hex or name
label.borderWidth

number
label.borderType

'solid' 'dashed' 'dotted'
label.borderRadius

number
label.shadowColor

hex or name
label.shadowBlur

number
label.shadowOffsetY

number
label.shadowOffsetX

number
label.width

number
label.height

number
label.textBorderColor

hex or name
label.textBorderWidth

number
label.textShadowColor

hex or name
label.textShadowBlur

number
label.textShadowOffsetY

number
label.textShadowOffsetX

number

Value

The modified echarts4r object

Enhanced Legend Setter for echarts4r

Description

Exposes every legend.* option so you don't have to hand-craft the JSON.

Usage

e_legend_full(
  e = NULL,
  legend.show = FALSE,
  legend.type = "scroll",
  legend.selector = "all",
  legend.icon = NULL,
  legend.align = "auto",
  legend.padding = c(5, 10, 5, 10),
  legend.itemGap = 10,
  legend.itemWidth = 25,
  legend.orient = "horizontal",
  legend.width = NULL,
  legend.height = "240px",
  legend.left = NULL,
  legend.right = 50,
  legend.top = 40,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = NULL,
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = NULL,
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = NULL,
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL
)

Arguments

e

An echarts4r object
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric

Value

The modified echarts4r object

Enhanced line Setter for echarts4r

Description

Exposes line* option so you don't have to hand-craft the JSON.

Usage

e_line_full(
  e = NULL,
  serie = NULL,
  y_index = 0,
  x_index = 0,
  smooth = NULL,
  showSymbol = NULL,
  label = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL
)

Arguments

e

plot object
serie

Variable
y_index

default 0
x_index

default 0
smooth

Smooth line
showSymbol

Logical
label

logical
lineStyle.width

numeric
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowColor

hex or color
lineStyle.shadowBlur

numeric
lineStyle.shadowOffsetX

numeric
lineStyle.shadowOffsetY

numeric

Value

The modified echarts4r object

Parallel customization

Description

Expose most parallel options

Usage

e_parallel_full(
  e,
  vars,
  rm_x = TRUE,
  rm_y = TRUE,
  lineStyle.color = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL,
  lineStyle.opacity = NULL,
  lineStyle.emphasis.color = NULL,
  lineStyle.emphasis.width = NULL,
  lineStyle.emphasis.type = NULL,
  lineStyle.emphasis.shadowBlur = NULL,
  lineStyle.emphasis.shadowColor = NULL,
  lineStyle.emphasis.shadowOffsetX = NULL,
  lineStyle.emphasis.shadowOffsetY = NULL,
  lineStyle.emphasis.opacity = NULL
)

Arguments

e

plot
vars

character vector
rm_x

logical
rm_y

logical
lineStyle.color

hex or color
lineStyle.width

number
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowBlur

number
lineStyle.shadowColor

hex or color
lineStyle.shadowOffsetX

number
lineStyle.shadowOffsetY

number
lineStyle.opacity

decimal
lineStyle.emphasis.color

hex or color
lineStyle.emphasis.width

number
lineStyle.emphasis.type

'solid' 'dashed' 'dotted'
lineStyle.emphasis.shadowBlur

number
lineStyle.emphasis.shadowColor

hex or color
lineStyle.emphasis.shadowOffsetX

number
lineStyle.emphasis.shadowOffsetY

number
lineStyle.emphasis.opacity

decimal

Value

The modified echarts4r object

Enhanced step Setter for echarts4r

Description

Exposes step* option so you don't have to hand-craft the JSON.

Usage

e_step_full(
  e = NULL,
  serie = NULL,
  y_index = 0,
  x_index = 0,
  showSymbol = NULL,
  label = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL
)

Arguments

e

plot object
serie

Variable
y_index

default 0
x_index

default 0
showSymbol

Logical
label

logical
lineStyle.width

numeric
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowColor

hex or color
lineStyle.shadowBlur

numeric
lineStyle.shadowOffsetX

numeric
lineStyle.shadowOffsetY

numeric

Value

The modified echarts4r object

Enhanced Title Setter for echarts4r

Description

Exposes every title.* option so you don't have to hand-craft the JSON.

Usage

e_title_full(
  e = NULL,
  title.text = NULL,
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = NULL,
  title.top = NULL,
  title.left = NULL,
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = NULL,
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = NULL,
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL
)

Arguments

e

An echarts4r object
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric

Value

The modified echarts4r object

toolbox function

Description

exposed parameters for toolbox

Usage

e_toolbox_full(
  e = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL
)

Arguments

e

existing plot
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric

Value

The modified echarts4r object

Accessible chart controls outside the plotting area

Description

Adds named keyboard/touch controls for selection zoom, reset and PNG export. More tools reveals the existing native ECharts toolbox; no analytical values or series are changed. The chart resizes within its original widget bounds. Native toolbox icons retain ECharts' own interaction/accessibility limits.

Usage

e_toolbox_panel(e)

Arguments

e

An echarts4r widget with an existing toolbox.

Value

The widget, with a presentation-only render hook.

Enhanced Tooltip Setter for echarts4r

Description

Exposes every tooltip.* option so you don't have to hand-craft the JSON.

Usage

e_tooltip_full(
  e,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = NULL,
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL
)

Arguments

e

An echarts4r object
tooltip.show

logical
tooltip.trigger

"cross" "axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric

Value

The modified echarts4r object

Extended treemap helper for echarts4r

Description

This is a thin wrapper around echarts4r::e_treemap() that exposes a large portion of the treemap series options as R arguments so that AutoPlots can drive them from UI controls.

Usage

e_treemap_full(
  e,
  name = NULL,
  GroupVars = NULL,
  squareRatio = NULL,
  leafDepth = NULL,
  drillDownIcon = NULL,
  roam = NULL,
  scaleLimit.min = NULL,
  scaleLimit.max = NULL,
  nodeClick = NULL,
  zoomToNodeRatio = NULL,
  visualDimension = NULL,
  visualMin = NULL,
  visualMax = NULL,
  colorAlpha = NULL,
  colorSaturation = NULL,
  colorMappingBy = NULL,
  visibleMin = NULL,
  childrenVisibleMin = NULL,
  label.show = NULL,
  label.position = NULL,
  label.distance = NULL,
  label.rotate = NULL,
  label.offset = NULL,
  label.textMargin = NULL,
  label.minMargin = NULL,
  label.formatter = NULL,
  label.color = NULL,
  label.fontStyle = NULL,
  label.fontWeight = NULL,
  label.fontFamily = NULL,
  label.fontSize = NULL,
  label.align = NULL,
  label.verticalAlign = NULL,
  label.lineHeight = NULL,
  label.backgroundColor = NULL,
  label.borderColor = NULL,
  label.borderWidth = NULL,
  label.borderType = NULL,
  label.borderDashOffset = NULL,
  label.borderRadius = NULL,
  label.padding = NULL,
  label.shadowColor = NULL,
  label.shadowBlur = NULL,
  label.shadowOffsetX = NULL,
  label.shadowOffsetY = NULL,
  label.width = NULL,
  label.height = NULL,
  label.textBorderColor = NULL,
  label.textBorderWidth = NULL,
  label.textBorderType = NULL,
  label.textBorderDashOffset = NULL,
  label.textShadowColor = NULL,
  label.textShadowBlur = NULL,
  label.textShadowOffsetX = NULL,
  label.textShadowOffsetY = NULL,
  label.overflow = NULL,
  label.ellipsis = NULL,
  label.rich = NULL,
  label.richInheritPlainLabel = NULL,
  upperLabel.show = NULL,
  upperLabel.position = NULL,
  upperLabel.distance = NULL,
  upperLabel.rotate = NULL,
  upperLabel.offset = NULL,
  upperLabel.formatter = NULL,
  upperLabel.color = NULL,
  upperLabel.fontStyle = NULL,
  upperLabel.fontWeight = NULL,
  upperLabel.fontFamily = NULL,
  upperLabel.fontSize = NULL,
  upperLabel.align = NULL,
  upperLabel.verticalAlign = NULL,
  upperLabel.lineHeight = NULL,
  upperLabel.backgroundColor = NULL,
  upperLabel.borderColor = NULL,
  upperLabel.borderWidth = NULL,
  upperLabel.borderType = NULL,
  upperLabel.borderDashOffset = NULL,
  upperLabel.borderRadius = NULL,
  upperLabel.padding = NULL,
  upperLabel.shadowColor = NULL,
  upperLabel.shadowBlur = NULL,
  upperLabel.shadowOffsetX = NULL,
  upperLabel.shadowOffsetY = NULL,
  upperLabel.width = NULL,
  upperLabel.height = NULL,
  upperLabel.textBorderColor = NULL,
  upperLabel.textBorderWidth = NULL,
  upperLabel.textBorderType = NULL,
  upperLabel.textBorderDashOffset = NULL,
  upperLabel.textShadowColor = NULL,
  upperLabel.textShadowBlur = NULL,
  upperLabel.textShadowOffsetX = NULL,
  upperLabel.textShadowOffsetY = NULL,
  upperLabel.overflow = NULL,
  upperLabel.ellipsis = NULL,
  upperLabel.rich = NULL,
  upperLabel.richInheritPlainLabel = NULL,
  itemStyle.color = NULL,
  itemStyle.borderRadius = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.gapWidth = NULL,
  itemStyle.borderColor = NULL,
  itemStyle.borderColorSaturation = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.shadowOffsetY = NULL,
  itemStyle.opacity = NULL,
  itemStyle.decal = NULL,
  emphasis.disabled = FALSE,
  emphasis.focus = "ancestor",
  emphasis.blurScope = "coordinateSystem",
  emphasis.label = NULL,
  emphasis.labelLine = NULL,
  emphasis.upperLabel = NULL,
  emphasis.itemStyle.color = NULL,
  emphasis.itemStyle.borderColor = "rgba(255,255,255,0.95)",
  emphasis.itemStyle.borderWidth = 2,
  emphasis.itemStyle.shadowBlur = 20,
  emphasis.itemStyle.shadowColor = "rgba(255,255,255,0.70)",
  emphasis.itemStyle.shadowOffsetX = 0,
  emphasis.itemStyle.shadowOffsetY = 0,
  emphasis.itemStyle.opacity = 1,
  blur.label = NULL,
  blur.labelLine = NULL,
  blur.upperLabel = NULL,
  blur.itemStyle.color = NULL,
  blur.itemStyle.borderColor = NULL,
  blur.itemStyle.borderWidth = NULL,
  blur.itemStyle.shadowBlur = NULL,
  blur.itemStyle.shadowColor = NULL,
  blur.itemStyle.shadowOffsetX = NULL,
  blur.itemStyle.shadowOffsetY = NULL,
  blur.itemStyle.opacity = 0.35,
  breadcrumb.show = NULL,
  breadcrumb.left = NULL,
  breadcrumb.top = NULL,
  breadcrumb.right = NULL,
  breadcrumb.bottom = NULL,
  breadcrumb.height = NULL,
  breadcrumb.emptyItemWidth = NULL,
  breadcrumb.itemStyle.color = NULL,
  breadcrumb.itemStyle.borderColor = NULL,
  breadcrumb.itemStyle.borderWidth = NULL,
  breadcrumb.itemStyle.borderRadius = NULL,
  breadcrumb.itemStyle.shadowBlur = NULL,
  breadcrumb.itemStyle.shadowColor = NULL,
  breadcrumb.itemStyle.shadowOffsetX = NULL,
  breadcrumb.itemStyle.shadowOffsetY = NULL,
  breadcrumb.itemStyle.textStyle.color = NULL,
  breadcrumb.itemStyle.textStyle.fontSize = NULL,
  breadcrumb.itemStyle.textStyle.fontFamily = NULL,
  breadcrumb.emphasis.borderColor = NULL,
  breadcrumb.emphasis.borderWidth = NULL,
  breadcrumb.emphasis.shadowBlur = NULL,
  breadcrumb.emphasis.shadowColor = NULL,
  breadcrumb.emphasis.shadowOffsetX = NULL,
  breadcrumb.emphasis.shadowOffsetY = NULL,
  breadcrumb.emphasis.textStyle.color = NULL,
  breadcrumb.emphasis.textStyle.fontSize = NULL,
  breadcrumb.emphasis.textStyle.fontFamily = NULL,
  silent = NULL,
  animationDuration = NULL,
  animationEasing = NULL,
  animationDelay = NULL,
  tooltip = NULL,
  cursor = NULL
)

Arguments

e

An echarts4r object to which the treemap series will be added.
name

Optional series name used in the legend and tooltip.
GroupVars

Character vector of grouping variables used to build the hierarchical treemap structure (ordered from top level to leaf level).
squareRatio

Numeric squarify aspect ratio for the treemap layout.
leafDepth

Integer maximum depth of nodes to display. Typically length(GroupVars) when using all levels.
drillDownIcon

Character string for the drill-down icon.
roam

Logical or character; controls whether panning/zooming is enabled. Can be FALSE, TRUE, "scale", or "move". Maps to ECharts series.treemap.roam.
scaleLimit.min

Optional numeric; minimum zoom scale for the treemap (ECharts series.treemap.scaleLimit.min).
scaleLimit.max

Optional numeric; maximum zoom scale for the treemap (ECharts series.treemap.scaleLimit.max).
nodeClick

Character specifying the behaviour when a node is clicked. Common values: "zoomToNode", "link", "false" (string) to disable.
zoomToNodeRatio

Numeric zoom ratio when using nodeClick = "zoomToNode".
visualDimension

Integer or character specifying which dimension is used for visual mapping (e.g. index of dimension or its name).
visualMin

Numeric; minimum of the visual mapping range for the selected visualDimension.
visualMax

Numeric; maximum of the visual mapping range for the selected visualDimension.
colorAlpha

Optional numeric length-2 vector for alpha channel range (e.g. c(0.3, 1)).
colorSaturation

Optional numeric length-2 vector for color saturation range (e.g. c(0.3, 1)).
colorMappingBy

Character specifying how colors are mapped. Typically "index" or "value".
visibleMin

Numeric threshold that hides nodes whose area is smaller than this value.
childrenVisibleMin

Numeric threshold that hides children nodes whose area is smaller than this value.
label.show

Logical; whether node labels are shown (ECharts label.show).
label.position

Character; position of the label relative to the node. Common values: "top", "left", "right", "bottom", "inside", "insideLeft", "insideRight", etc.
label.distance

Numeric or integer; distance to the element when label is outside the node (ECharts label.distance).
label.rotate

Numeric or character; rotation of label text in degrees or "radial", "tangential" depending on context.
label.offset

Numeric/integer vector or list; x/y offset of label from its default position (ECharts label.offset).
label.textMargin

Numeric/integer; extra margin around label text box.
label.minMargin

Numeric/integer; minimum margin between label and node edge.
label.formatter

Character or list; text formatter for labels (string template or JS function).
label.color

Character; text color of labels.
label.fontStyle

Character; label font style. Common values: "normal", "italic", "oblique".
label.fontWeight

Character or numeric; label font weight. E.g. "normal", "bold", "bolder", "lighter", or numeric weights like 400, 700.
label.fontFamily

Character; label font family name.
label.fontSize

Numeric/integer; label font size (px).
label.align

Character; horizontal alignment of label text. One of "left", "center", "right".
label.verticalAlign

Character; vertical alignment of label text. One of "top", "middle", "bottom".
label.lineHeight

Numeric/integer; line height of label text.
label.backgroundColor

Character or list; background color for label (or style object).
label.borderColor

Character; label border color.
label.borderWidth

Numeric/integer; label border width (px).
label.borderType

Character or numeric; border type for label. E.g. "solid", "dashed", "dotted" or numeric pattern.
label.borderDashOffset

Numeric; dash offset for dashed label border.
label.borderRadius

Numeric/integer or vector; corner radius for label background.
label.padding

Numeric/integer or vector; padding inside label box.
label.shadowColor

Character; shadow color of label box.
label.shadowBlur

Numeric/integer; shadow blur radius for label.
label.shadowOffsetX

Numeric/integer; horizontal shadow offset.
label.shadowOffsetY

Numeric/integer; vertical shadow offset.
label.width

Numeric/integer or character; forced label width.
label.height

Numeric/integer or character; forced label height.
label.textBorderColor

Character; color of text stroke (outline).
label.textBorderWidth

Numeric/integer; width of text stroke.
label.textBorderType

Character or numeric; border type of text stroke ("solid", "dashed", etc.).
label.textBorderDashOffset

Numeric; dash offset for text stroke.
label.textShadowColor

Character; color of text shadow.
label.textShadowBlur

Numeric/integer; blur radius of text shadow.
label.textShadowOffsetX

Numeric/integer; horizontal text shadow offset.
label.textShadowOffsetY

Numeric/integer; vertical text shadow offset.
label.overflow

Character; how to handle text overflow. Common values: "truncate", "break", "breakAll".
label.ellipsis

Character; string used as ellipsis when truncating text.
label.rich

List; rich text styles object for label rich text.
label.richInheritPlainLabel

Logical; whether rich text inherits plain label styles.
upperLabel.show

Logical; whether upper-level labels are shown (ECharts upperLabel.show).
upperLabel.position

Character; position of the upper-level label. Same options as label.position.
upperLabel.distance

Numeric/integer; distance to element when upper label is outside the node.
upperLabel.rotate

Numeric or character; rotation of upper-level label.
upperLabel.offset

Numeric/integer vector or list; offset for upper-level label position.
upperLabel.formatter

Character or list; formatter for upper-level labels (string template or JS function).
upperLabel.color

Character; text color of upper-level labels.
upperLabel.fontStyle

Character; font style for upper-level labels ("normal", "italic", etc.).
upperLabel.fontWeight

Character or numeric; font weight for upper-level labels.
upperLabel.fontFamily

Character; font family for upper-level labels.
upperLabel.fontSize

Numeric/integer; font size for upper-level labels.
upperLabel.align

Character; horizontal alignment of upper-level text.
upperLabel.verticalAlign

Character; vertical alignment of upper-level text.
upperLabel.lineHeight

Numeric/integer; line height of upper-level text.
upperLabel.backgroundColor

Character or list; background color for upper-level label box.
upperLabel.borderColor

Character; border color for upper-level label.
upperLabel.borderWidth

Numeric/integer; border width for upper-level label.
upperLabel.borderType

Character or numeric; border type for upper-level label.
upperLabel.borderDashOffset

Numeric; dash offset for upper-level label border.
upperLabel.borderRadius

Numeric/integer or vector; border radius for upper-level label box.
upperLabel.padding

Numeric/integer or vector; padding for upper-level label box.
upperLabel.shadowColor

Character; shadow color for upper-level label.
upperLabel.shadowBlur

Numeric/integer; shadow blur for upper-level label.
upperLabel.shadowOffsetX

Numeric/integer; horizontal shadow offset for upper-level label.
upperLabel.shadowOffsetY

Numeric/integer; vertical shadow offset for upper-level label.
upperLabel.width

Numeric/integer or character; forced width for upper-level label.
upperLabel.height

Numeric/integer or character; forced height for upper-level label.
upperLabel.textBorderColor

Character; text stroke color for upper-level label.
upperLabel.textBorderWidth

Numeric/integer; text stroke width for upper-level label.
upperLabel.textBorderType

Character or numeric; text stroke type for upper-level label.
upperLabel.textBorderDashOffset

Numeric; dash offset for upper-level text stroke.
upperLabel.textShadowColor

Character; text shadow color for upper-level label.
upperLabel.textShadowBlur

Numeric/integer; text shadow blur for upper-level label.
upperLabel.textShadowOffsetX

Numeric/integer; horizontal text shadow offset for upper-level label.
upperLabel.textShadowOffsetY

Numeric/integer; vertical text shadow offset for upper-level label.
upperLabel.overflow

Character; overflow behaviour for upper-level text ("truncate", "break", etc.).
upperLabel.ellipsis

Character; ellipsis string for upper-level text.
upperLabel.rich

List; rich text styles object for upper-level labels.
upperLabel.richInheritPlainLabel

Logical; whether rich text styles for upper-level labels inherit plain label styles.
itemStyle.color

Character or list; node color or style object for itemStyle.color.
itemStyle.borderRadius

Numeric/integer or vector; border radius for node rectangles.
itemStyle.borderWidth

Numeric/integer; border width of node rectangles.
itemStyle.gapWidth

Numeric/integer; gap width between nodes.
itemStyle.borderColor

Character; border color of node rectangles.
itemStyle.borderColorSaturation

Numeric; saturation adjustment of border color when colorSaturation is used.
itemStyle.shadowBlur

Numeric/integer; blur radius for node shadow.
itemStyle.shadowColor

Character; shadow color for nodes.
itemStyle.shadowOffsetX

Numeric/integer; horizontal node shadow offset.
itemStyle.shadowOffsetY

Numeric/integer; vertical node shadow offset.
itemStyle.opacity

Numeric in [0, 1]; opacity of nodes.
itemStyle.decal

List; decal pattern options for nodes.
emphasis.disabled

Logical; whether emphasis (hover) is disabled for this series.
emphasis.focus

Character; focus mode when hovering. Typical values: "none", "self", "ancestor", "descendant".
emphasis.blurScope

Character; blur scope of non-focused elements. Common values: "coordinateSystem", "series", "global".
emphasis.label

List; label options applied in emphasis state (overrides label when hovered).
emphasis.labelLine

List; label line options in emphasis state.
emphasis.upperLabel

List; upper-level label options in emphasis state.
emphasis.itemStyle.color

Character or NULL; fill color for treemap nodes in the emphasis (hover) state. Maps to emphasis.itemStyle.color.
emphasis.itemStyle.borderColor

Character or NULL; border color for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.borderColor.
emphasis.itemStyle.borderWidth

Numeric or NULL; border width (in pixels) for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.borderWidth.
emphasis.itemStyle.shadowBlur

Numeric or NULL; blur radius for the drop shadow of treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowBlur.
emphasis.itemStyle.shadowColor

Character or NULL; shadow color for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowColor.
emphasis.itemStyle.shadowOffsetX

Numeric or NULL; horizontal offset (in pixels) of the shadow for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowOffsetX.
emphasis.itemStyle.shadowOffsetY

Numeric or NULL; vertical offset (in pixels) of the shadow for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowOffsetY.
emphasis.itemStyle.opacity

Numeric or NULL; opacity of treemap nodes in the emphasis state, typically a value in [0, 1]. Maps to emphasis.itemStyle.opacity.
blur.label

List; label options in blur state (when other items are focused).
blur.labelLine

List; label line options in blur state.
blur.upperLabel

List; upper-level label options in blur state.
blur.itemStyle.color

Character or NULL; fill color for treemap nodes in the blur (de-emphasized) state when other nodes are highlighted. Maps to blur.itemStyle.color.
blur.itemStyle.borderColor

Character or NULL; border color for treemap nodes in the blur state. Maps to blur.itemStyle.borderColor.
blur.itemStyle.borderWidth

Numeric or NULL; border width (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.borderWidth.
blur.itemStyle.shadowBlur

Numeric or NULL; blur radius for the drop shadow of treemap nodes in the blur state. Maps to blur.itemStyle.shadowBlur.
blur.itemStyle.shadowColor

Character or NULL; shadow color for treemap nodes in the blur state. Maps to blur.itemStyle.shadowColor.
blur.itemStyle.shadowOffsetX

Numeric or NULL; horizontal shadow offset (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.shadowOffsetX.
blur.itemStyle.shadowOffsetY

Numeric or NULL; vertical shadow offset (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.shadowOffsetY.
blur.itemStyle.opacity

Numeric or NULL; opacity of treemap nodes in the blur state, typically a value in [0, 1]. Maps to blur.itemStyle.opacity.
breadcrumb.show

Logical; whether to display the treemap breadcrumb navigation bar.
breadcrumb.left

Position of the breadcrumb container from the left; numeric (px) or character e.g. "center"
breadcrumb.top

Position of the breadcrumb container from the top; numeric (px) or character.
breadcrumb.right

Position of the breadcrumb container from the right; numeric (px) or character.
breadcrumb.bottom

Position of the breadcrumb container from the bottom; numeric (px) or character.
breadcrumb.height

Height of the breadcrumb bar.
breadcrumb.emptyItemWidth

Width of a breadcrumb node when it has no name (placeholder width).
breadcrumb.itemStyle.color

Background color of breadcrumb nodes.
breadcrumb.itemStyle.borderColor

Border color for breadcrumb nodes.
breadcrumb.itemStyle.borderWidth

Border width for breadcrumb nodes.
breadcrumb.itemStyle.borderRadius

Corner radius for breadcrumb nodes.
breadcrumb.itemStyle.shadowBlur

Shadow blur radius for breadcrumb nodes.
breadcrumb.itemStyle.shadowColor

Shadow color for breadcrumb nodes.
breadcrumb.itemStyle.shadowOffsetX

Horizontal shadow offset (in px) for breadcrumb nodes.
breadcrumb.itemStyle.shadowOffsetY

Vertical shadow offset (in px) for breadcrumb nodes.
breadcrumb.itemStyle.textStyle.color

Text color for breadcrumb labels.
breadcrumb.itemStyle.textStyle.fontSize

Font size for breadcrumb labels.
breadcrumb.itemStyle.textStyle.fontFamily

Font family for breadcrumb labels.
breadcrumb.emphasis.borderColor

Border color when a breadcrumb node is emphasized (hover/active).
breadcrumb.emphasis.borderWidth

Border width when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowBlur

Shadow blur radius when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowColor

Shadow color when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowOffsetX

Horizontal shadow offset (in px) when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowOffsetY

Vertical shadow offset (in px) when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.color

Text color when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.fontSize

Font size when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.fontFamily

Font family when a breadcrumb node is emphasized.
silent

Logical indicating whether mouse events are disabled for this series.
animationDuration

Numeric animation duration in milliseconds.
animationEasing

Character name of the easing function used for the treemap animation (e.g. "linear", "quadraticIn", etc.).
animationDelay

Numeric delay (in milliseconds) before animation starts.
tooltip

Optional list of series-level tooltip options. If NULL, a default formatter can be supplied by the caller.
cursor

Character CSS cursor to use when hovering over nodes (e.g. "pointer", "default").
emphasis.itemStyle

List; general item style options in emphasis state.
blur.itemStyle

List; general item style options in blur state.

Value

An echarts4r object with a treemap series added.

Enhanced violin setter for echarts4r

Description

Exposes every violin itemStyle option so you don't have to hand-craft the JSON. Mirrors e_boxplot_full() but uses e_violin_() under the hood.

Usage

e_violin_full(
  e = NULL,
  serie = NULL,
  label = FALSE,
  itemStyle.color = NULL,
  itemStyle.opacity = NULL,
  itemStyle.borderColor = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.borderType = NULL,
  itemStyle.borderCap = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.shadowOffsetY = NULL
)

Arguments

e

plot object
serie

Variable
label

Logical; whether to show labels.
itemStyle.color

Fill color. Can be a single color or vector of multiple colors for a vertical gradient.
itemStyle.opacity

Transparency (0–1). Can be scalar or vector matching itemStyle.color.
itemStyle.borderColor

hex or color name
itemStyle.borderWidth

numeric
itemStyle.borderType

'solid' 'dashed' 'dotted'
itemStyle.borderCap

'butt' 'round' 'square'
itemStyle.shadowBlur

numeric
itemStyle.shadowColor

hex or name
itemStyle.shadowOffsetX

numeric
itemStyle.shadowOffsetY

numeric

Value

The modified echarts4r object

Enhanced visual map

Description

Exposes most visual map options

Usage

e_visual_map_full(
  e,
  serie,
  visualMap.show = TRUE,
  visualMap.min = NULL,
  visualMap.max = NULL,
  visualMap.orient = NULL,
  visualMap.right = NULL,
  visualMap.top = NULL,
  visualMap.bottom = NULL,
  visualMap.left = NULL,
  visualMap.backgroundColor = NULL,
  visualMap.borderColor = NULL,
  visualMap.borderWidth = NULL,
  visualMap.InRange.color = NULL,
  visualMap.InRange.opacity = NULL,
  visualMap.InRange.symbol = NULL,
  visualMap.InRange.symbolSize = NULL
)

Arguments

e

An echarts4r object
serie

ZVar XVar YVar
visualMap.show

logical
visualMap.min

min value
visualMap.max

max value
visualMap.orient

'vertical' 'horizontal'
visualMap.right

number
visualMap.top

number
visualMap.bottom

number
visualMap.left

number
visualMap.backgroundColor

hex or name
visualMap.borderColor

hex or name
visualMap.borderWidth

number
visualMap.InRange.color

hex or name
visualMap.InRange.opacity

number
visualMap.InRange.symbol

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
visualMap.InRange.symbolSize

number

Value

plot

Enhanced X-Axis Setter for echarts4r

Description

Exposes every xAxis.* option so you don't have to hand-craft the JSON.

Usage

e_x_axis_full(
  e,
  index = 0,
  serie = NULL,
  axis = "x",
  xAxis.title = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 15,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = NULL,
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = NULL,
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = NULL,
  xAxis.axisLabel.fontSize = NULL,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL
)

Arguments

e

An echarts4r object
index

Which x axis to target (zero-based). Default: 0
serie

NULL
axis

"x"
xAxis.title

Axis title
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.min

Min value
xAxis.max

Max value
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'

Value

The modified echarts4r object

Enhanced Y-Axis Setter for echarts4r

Description

Exposes every yAxis.* option so you don't have to hand-craft the JSON.

Usage

e_y_axis_full(
  e,
  index = 0,
  serie = NULL,
  axis = "y",
  yAxis.title = NULL,
  yAxis.position = "bottom",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 15,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = NULL,
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = NULL,
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = NULL,
  yAxis.axisLabel.fontSize = NULL,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL
)

Arguments

e

An echarts4r object
index

Which y axis to target (zero-based). Default: 0
serie

NULL
axis

"y"
yAxis.title

Axis title
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.min

Min value
yAxis.max

Max value
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'

Value

The modified echarts4r object

FakeDataGenerator

Description

Create fake data for examples

Usage

FakeDataGenerator(
  Correlation = 0.7,
  N = 1000L,
  ID = 5L,
  FactorCount = 2L,
  AddDate = TRUE,
  AddComment = FALSE,
  AddWeightsColumn = FALSE,
  ZIP = 5L,
  ChainLadderData = FALSE,
  Classification = FALSE,
  MultiClass = FALSE
)

Arguments

Correlation

Set the correlation value for simulated data
N

Number of records
ID

Number of IDcols to include
FactorCount

Number of factor type columns to create
AddDate

Set to TRUE to include a date column
AddComment

Set to TRUE to add a comment column
AddWeightsColumn

Add a weights column for ML
ZIP

Zero Inflation Model target variable creation. Select from 0 to 5 to create that number of distinctly distributed data, stratifed from small to large
ChainLadderData

Set to TRUE to return Chain Ladder Data for using AutoMLChainLadderTrainer
Classification

Set to TRUE to build classification data
MultiClass

Set to TRUE to build MultiClass data

Value

data.table of data

Author(s)

Adrian Antico

Gains

Description

Create a cumulative gains chart

Usage

Gains(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

NULL
Width

NULL
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

HeatMap

Description

Create heat maps with numeric or categorical dt

Usage

HeatMap(
  dt,
  PreAgg = TRUE,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  MouseScroll = FALSE,
  visualMap.show = TRUE,
  visualMap.min = NULL,
  visualMap.max = NULL,
  visualMap.orient = "vertical",
  visualMap.right = "2%",
  visualMap.top = "middle",
  visualMap.bottom = NULL,
  visualMap.left = NULL,
  visualMap.backgroundColor = NULL,
  visualMap.borderColor = NULL,
  visualMap.borderWidth = NULL,
  visualMap.InRange.color = NULL,
  visualMap.InRange.opacity = NULL,
  visualMap.InRange.symbol = NULL,
  visualMap.InRange.symbolSize = NULL,
  itemStyle.borderColor = NULL,
  itemStyle.borderWidth = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowOffsetY = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.opacity = NULL,
  itemStyle.borderRadius = NULL,
  emphasis.shadowColor = NULL,
  emphasis.shadowBlur = NULL,
  itemStyle.emphasis.label.show = NULL,
  itemStyle.emphasis.label.color = NULL,
  itemStyle.emphasis.label.fontStyle = NULL,
  itemStyle.emphasis.label.fontWeight = NULL,
  itemStyle.emphasis.label.fontFamily = NULL,
  itemStyle.emphasis.label.fontSize = NULL,
  itemStyle.emphasis.label.align = NULL,
  itemStyle.emphasis.label.verticalAlign = NULL,
  itemStyle.emphasis.label.backgroundColor = NULL,
  itemStyle.emphasis.label.borderColor = NULL,
  itemStyle.emphasis.label.borderWidth = NULL,
  itemStyle.emphasis.label.borderType = NULL,
  itemStyle.emphasis.label.borderRadius = NULL,
  itemStyle.emphasis.label.shadowColor = NULL,
  itemStyle.emphasis.label.shadowBlur = NULL,
  itemStyle.emphasis.label.shadowOffsetY = NULL,
  itemStyle.emphasis.label.shadowOffsetX = NULL,
  itemStyle.emphasis.label.width = NULL,
  itemStyle.emphasis.label.height = NULL,
  itemStyle.emphasis.label.textBorderColor = NULL,
  itemStyle.emphasis.label.textBorderWidth = NULL,
  itemStyle.emphasis.label.textShadowColor = NULL,
  itemStyle.emphasis.label.textShadowBlur = NULL,
  itemStyle.emphasis.label.textShadowOffsetY = NULL,
  itemStyle.emphasis.label.textShadowOffsetX = NULL,
  label.show = NULL,
  label.color = NULL,
  label.fontStyle = NULL,
  label.fontWeight = NULL,
  label.fontFamily = NULL,
  label.fontSize = NULL,
  label.align = NULL,
  label.verticalAlign = NULL,
  label.backgroundColor = NULL,
  label.borderColor = NULL,
  label.borderWidth = NULL,
  label.borderType = NULL,
  label.borderRadius = NULL,
  label.shadowColor = NULL,
  label.shadowBlur = NULL,
  label.shadowOffsetY = NULL,
  label.shadowOffsetX = NULL,
  label.width = NULL,
  label.height = NULL,
  label.textBorderColor = NULL,
  label.textBorderWidth = NULL,
  label.textShadowColor = NULL,
  label.textShadowBlur = NULL,
  label.textShadowOffsetY = NULL,
  label.textShadowOffsetX = NULL,
  title.text = "Heatmap",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

'mean', 'median', 'sum', 'sd', 'coeffvar', 'count'
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_Y

= 20
NumLevels_X

= 20.
Height

"400px"
Width

"200px"
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
visualMap.show

TRUE
visualMap.min

min value
visualMap.max

max value
visualMap.orient

'vertical' 'horizontal'
visualMap.right

number
visualMap.top

number
visualMap.bottom

number
visualMap.left

number
visualMap.backgroundColor

hex or name
visualMap.borderColor

hex or name
visualMap.borderWidth

number
visualMap.InRange.color

hex or name
visualMap.InRange.opacity

number
visualMap.InRange.symbol

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
visualMap.InRange.symbolSize

number
itemStyle.borderColor

hex or name
itemStyle.borderWidth

number
itemStyle.shadowColor

hex or name
itemStyle.shadowBlur

number
itemStyle.shadowOffsetY

number
itemStyle.shadowOffsetX

number
itemStyle.opacity

decimal
itemStyle.borderRadius

number
emphasis.shadowColor

hex or name
emphasis.shadowBlur

number
itemStyle.emphasis.label.show

logical
itemStyle.emphasis.label.color

hex or name
itemStyle.emphasis.label.fontStyle

'normal' 'italic' 'oblique'
itemStyle.emphasis.label.fontWeight

'normal' 'bold' 'bolder' 'lighter'
itemStyle.emphasis.label.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
itemStyle.emphasis.label.fontSize

number
itemStyle.emphasis.label.align

'left' 'center' 'right'
itemStyle.emphasis.label.verticalAlign

'top' 'middle' 'bottom'
itemStyle.emphasis.label.backgroundColor

hex or name
itemStyle.emphasis.label.borderColor

hex or name
itemStyle.emphasis.label.borderWidth

number
itemStyle.emphasis.label.borderType

'solid' 'dashed' 'dotted'
itemStyle.emphasis.label.borderRadius

number
itemStyle.emphasis.label.shadowColor

hex or name
itemStyle.emphasis.label.shadowBlur

number
itemStyle.emphasis.label.shadowOffsetY

number
itemStyle.emphasis.label.shadowOffsetX

number
itemStyle.emphasis.label.width

number
itemStyle.emphasis.label.height

number
itemStyle.emphasis.label.textBorderColor

hex or name
itemStyle.emphasis.label.textBorderWidth

number
itemStyle.emphasis.label.textShadowColor

hex or name
itemStyle.emphasis.label.textShadowBlur

number
itemStyle.emphasis.label.textShadowOffsetY

number
itemStyle.emphasis.label.textShadowOffsetX

number
label.show

logical
label.color

hex or name
label.fontStyle

'normal' 'italic' 'oblique'
label.fontWeight

'normal' 'bold' 'bolder' 'lighter'
label.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
label.fontSize

number
label.align

'left' 'center' 'right'
label.verticalAlign

'top' 'middle' 'bottom'
label.backgroundColor

hex or name
label.borderColor

hex or name
label.borderWidth

number
label.borderType

'solid' 'dashed' 'dotted'
label.borderRadius

number
label.shadowColor

hex or name
label.shadowBlur

number
label.shadowOffsetY

number
label.shadowOffsetX

number
label.width

number
label.height

number
label.textBorderColor

hex or name
label.textBorderWidth

number
label.textShadowColor

hex or name
label.textShadowBlur

number
label.textShadowOffsetY

number
label.textShadowOffsetX

number
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging parameter

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 10000)

# Echarts Heatmap Plot Chart
AutoPlots::HeatMap(
  dt = data,
  PreAgg = TRUE,
  XVar = "Factor_1",
  YVar = "Factor_2",
  ZVar = "Independent_Variable6",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  MouseScroll = FALSE,

  Debug = FALSE)

Histogram

Description

Build a histogram plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Histogram(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  GroupVar = NULL,
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 30,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  backgroundStyle.color = NULL,
  backgroundStyle.opacity = NULL,
  title.text = "Histogram",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 30
Height

"400px"
Width

"200px"
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
ShowLabels

FALSE
backgroundStyle.color

vector of colors
backgroundStyle.opacity

vector of opacities
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)))

# Create plot
AutoPlots::Histogram(
  dt = dt,
  SampleSize = 30000L,
  XVar = NULL,
  GroupVar = NULL,
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 30,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  Debug = FALSE)

Importance Pareto Plot

Description

Create a composite variable-importance plot that combines ranked importance bars with a cumulative contribution line. This is useful for understanding both the top drivers and how quickly their combined contribution approaches the total importance.

Usage

ImportancePareto(
  data,
  XVar = NULL,
  YVar = NULL,
  TopN = 25,
  Sort = TRUE,
  Cumulative = TRUE,
  CumulativeAxis = "right",
  Cutoff = 0.8,
  Theme = "dark",
  Title = NULL,
  Subtitle = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  MouseScroll = FALSE,
  Encoding = "human",
  Debug = FALSE,
  ...
)

Arguments

data

Source data frame or data.table containing feature names and importance values.
XVar

Feature/name column. If NULL, common names such as 'Feature' or 'Variable' are inferred when possible.
YVar

Numeric importance column. If NULL, common names such as 'Importance', 'Importances', or 'Gain' are inferred when possible.
TopN

Number of ranked features to display.
Sort

If TRUE, sort by absolute importance descending before taking 'TopN'.
Cumulative

If TRUE, add the cumulative contribution line.
CumulativeAxis

Side for the cumulative percentage axis. Use '"right"' or '"left"'.
Cutoff

Optional cumulative reference line. Values between 0 and 1 are treated as proportions; values between 1 and 100 are treated as percentages. Use NULL to omit the cutoff line.
Theme

AutoPlots/echarts theme name.
Title

Plot title. If NULL, a default title is used.
Subtitle

Plot subtitle.
Height

Widget height.
Width

Widget width.
ShowLabels

If TRUE, show labels on the importance bars.
MouseScroll

If TRUE, use inside data zoom. Otherwise, show external data zoom controls.
Encoding

Reserved for future consumer-aware information encoding. Current supported values are '"human"', '"llm"', '"thumbnail"', '"presentation"', '"executive"', and '"developer"'.
Debug

If TRUE, print intermediate diagnostics.
...

Reserved for future extensions.

Value

An echarts4r widget.

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Examples

importance <- data.table::data.table(
  Feature = paste0("Feature_", seq_len(12)),
  Importance = sort(stats::runif(12, 1, 100), decreasing = TRUE)
)
ImportancePareto(importance, XVar = "Feature", YVar = "Importance", TopN = 10)

catboost_style <- data.table::data.table(
  Feature = paste0("feature_", seq_len(20)),
  Importances = rev(seq_len(20)) ^ 1.2
)
ImportancePareto(catboost_style, TopN = 15, Cutoff = 0.9)

Lift

Description

Create a cumulative gains chart

Usage

Lift(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Line

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Line(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  Smooth = TRUE,
  ShowSymbol = FALSE,
  DarkMode = FALSE,
  lineStyle.color = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL,
  title.text = "Line Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

NULL
Width

NULL
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
Smooth

= TRUE
ShowSymbol

= FALSE
DarkMode

FALSE
lineStyle.color

hex or name
lineStyle.width

numeric
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowColor

hex or color
lineStyle.shadowBlur

numeric
lineStyle.shadowOffsetX

numeric
lineStyle.shadowOffsetY

numeric
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build Line plot
AutoPlots::Line(
  dt = data,
  PreAgg = TRUE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "LogPlus1",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "LogPlus1",
  GroupVar = NULL,
  Theme = "macarons")

PACF

Description

Build a partial autocorrelation plot by simply passing arguments to a single function

Usage

PACF(
  dt = NULL,
  YVar = NULL,
  DateVar = NULL,
  TimeUnit = NULL,
  MaxLags = 50,
  YVarTrans = "Identity",
  AggMethod = "sum",
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  title.text = "Partial Autocorrelation Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
DateVar

Date column in data
TimeUnit

Select from "hour", "day", "week", "month", "quarter", "year"
MaxLags

Max value for lags to test
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Parallel

Description

Build a parallel plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Parallel(
  dt = NULL,
  SampleSize = 50000,
  CorrVars = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  rm_x = TRUE,
  rm_y = TRUE,
  lineStyle.color = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL,
  lineStyle.opacity = NULL,
  lineStyle.emphasis.color = "red",
  lineStyle.emphasis.width = 5,
  lineStyle.emphasis.type = NULL,
  lineStyle.emphasis.shadowBlur = 5,
  lineStyle.emphasis.shadowColor = "black",
  lineStyle.emphasis.shadowOffsetX = NULL,
  lineStyle.emphasis.shadowOffsetY = NULL,
  lineStyle.emphasis.opacity = NULL,
  title.text = "Parallel Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

Sample size
CorrVars

vector of variable names
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
rm_x

logical. Remove x-axis
rm_y

logical. Remove y-axis
lineStyle.color

hex or color
lineStyle.width

number
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowBlur

number
lineStyle.shadowColor

hex or color
lineStyle.shadowOffsetX

number
lineStyle.shadowOffsetY

number
lineStyle.opacity

decimal
lineStyle.emphasis.color

hex or color
lineStyle.emphasis.width

number
lineStyle.emphasis.type

'solid' 'dashed' 'dotted'
lineStyle.emphasis.shadowBlur

number
lineStyle.emphasis.shadowColor

hex or color
lineStyle.emphasis.shadowOffsetX

number
lineStyle.emphasis.shadowOffsetY

number
lineStyle.emphasis.opacity

decimal
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create data
dt = AutoPlots::FakeDataGenerator(N = 100000)

# Create plot
AutoPlots::Parallel(
  dt = dt,
  SampleSize = 1000,
  CorrVars = c("Independent_Variable3",
               "Independent_Variable4",
               "Independent_Variable5",
               "Independent_Variable6",
               "Independent_Variable7"),
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  Debug = FALSE)

PartialDependence.Box

Description

This function automatically builds partial dependence calibration plots

Usage

PartialDependence.Box(
  dt = NULL,
  PreAgg = TRUE,
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  EchartsLabels = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
EchartsLabels

character
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

PartialDependence.HeatMap

Description

This function automatically builds partial dependence calibration plots

Usage

PartialDependence.HeatMap(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  MouseScroll = FALSE,
  Theme = "dark",
  EchartsLabels = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
ShowLabels

character
MouseScroll

logical, zoom via mouse scroll
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
EchartsLabels

character
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

PartialDependence.Line

Description

This function automatically builds partial dependence calibration plots

Usage

PartialDependence.Line(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  NumberBins = 20,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  EchartsLabels = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
GroupVar

Character variable
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
EchartsLabels

character
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Pie

Description

Build a pie chart by simply passing arguments to a single function

Usage

Pie(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = TRUE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = "Pie Chart",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "item",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Pie(
  dt = dt,
  PreAgg = TRUE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  Debug = FALSE)

Plot.ACF

Description

Build an autocorrelation plot by simply passing arguments to a single function

Usage

Plot.ACF(
  dt = NULL,
  YVar = NULL,
  DateVar = NULL,
  TimeUnit = NULL,
  MaxLags = 50,
  YVarTrans = "Identity",
  AggMethod = "sum",
  Height = NULL,
  Width = NULL,
  Title = "Autocorrelation Plot",
  EchartsTheme = "macarons",
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
DateVar

Date column in data
TimeUnit

Select from "hour", "day", "week", "month", "quarter", "year"
MaxLags

Max lag values to test
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Plot anomaly-score distribution

Description

Plot anomaly-score distribution

Usage

Plot.AnomalyScores(
  scores,
  flags = NULL,
  Title = "Anomaly-score distribution",
  EchartsTheme = "macarons",
  ...
)

Arguments

scores

Numeric anomaly scores.
flags

Optional logical flagged-observation indicator.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Histogram()].

Value

An 'echarts4r' htmlwidget.

Plot.Area

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.Area(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Line Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  Alpha = 0.5,
  Smooth = TRUE,
  ShowSymbol = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

"Title"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

Provide an "Echarts" theme
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
Alpha

0 to 1 for setting transparency
Smooth

= TRUE
ShowSymbol

= FALSE
TextColor

"Not Implemented"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes
Area

logical

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build plot
AutoPlots::Plot.Area(
  dt = data,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "Identity",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "Identity",
  GroupVar = NULL,
  EchartsTheme = "macarons")

Plot.Bar

Description

Build a bar plot by simply passing arguments to a single function

Usage

Plot.Bar(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  LabelValues = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Bar Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
LabelValues

A vector of values. Requires PreAgg to be set to TRUE and you'll need to ensure LabelValues are ordered the same as dt. If NULL and ShowLabels is TRUE, then bar values will be displayed
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
ShowLabels

logical
Title.YAxis

NULL. If NULL, YVar name will be used
Title.XAxis

NULL. If NULL, XVar name will be used
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts Bar Chart
AutoPlots::Plot.Bar(
  dt = data,
  PreAgg = FALSE,
  XVar = "Factor_1",
  YVar = "Adrian",
  GroupVar = NULL,
  LabelValues = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  Title = 'Bar Plot',
  ShowLabels = FALSE,
  Title.YAxis = "Adrian",
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.BarPlot3D

Description

Build a 3D Bar Plot

Usage

Plot.BarPlot3D(
  dt,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Title = "3D Bar Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "dark",
  MouseScroll = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical. Is your data pre aggregated
AggMethod

'mean', 'median', 'sum', 'sd', 'coeffvar', 'count'
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_Y

= 20
NumLevels_X

= 20
Height

"400px"
Width

"200px"
Title

"Heatmap"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"dark-blue"
MouseScroll

logical, zoom via mouse scroll
TextColor

character
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
zaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts 3D Bar Chart
AutoPlots::Plot.BarPlot3D(
  dt = data,
  PreAgg = FALSE,
  AggMethod = 'mean',
  XVar = "Factor_1",
  YVar = "Factor_2",
  ZVar = "Adrian",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Title = "3D Bar Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.BinaryMetrics

Description

Line plot of evaluation metrics across thresholds

Usage

Plot.BinaryMetrics(
  dt = NULL,
  PreAgg = FALSE,
  AggMethod = "mean",
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  Metrics = c("Utility", "MCC", "Accuracy", "F1_Score", "F2_Score", "F0.5_Score",
    "ThreatScore", "TPR", "TNR", "FNR", "FPR", "FDR", "FOR"),
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  CostMatrixWeights = c(0, 1, 1, 0),
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  Title = "Binary Metrics",
  MouseScroll = TRUE,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  EchartsLabels = FALSE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
Metrics

Multiple selection "Utility","MCC","Accuracy","F1_Score","F2_Score","F0.5_Score","ThreatScore","TPR","TNR","FNR","FPR","FDR","FOR"
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
CostMatrixWeights

vector length 4. FP, FP, FN, TP
NumberBins

numeric
Height

"400px"
Width

"200px"
Title

character
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
EchartsLabels

character
TimeLine

logical
TextColor

hex character
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Box

Description

Build a box plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Box(
  dt = NULL,
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Box Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
TextColor

character hex
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)), GV = sample(LETTERS, 1000, TRUE))

AutoPlots::Plot.Box(
  dt = dt,
  SampleSize = 100000L,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = 'Box Plot',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.Calibration.Box

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.Calibration.Box(
  dt = NULL,
  SampleSize = 100000L,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  Height = NULL,
  Width = NULL,
  Title = "Calibration Box",
  MouseScroll = TRUE,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
AggMethod

character
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
Title

character
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

"Not Implemented"
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Calibration.Line

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.Calibration.Line(
  dt = NULL,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  Height = NULL,
  Width = NULL,
  Title = "Calibration Line",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  MouseScroll = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
MouseScroll

logical, zoom via mouse scroll
TextColor

"Not Implemented"
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot an unsupervised embedding

Description

Reusable visualization for PCA scores, manifold embeddings, and other two-dimensional fitted representations. Model fitting remains the caller's responsibility.

Usage

Plot.ClusterEmbedding(
  dt,
  XVar,
  YVar,
  ClusterVar = NULL,
  Title = "Cluster embedding",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Tabular embedding output.
XVar, YVar

Numeric embedding columns.
ClusterVar

Optional cluster/segment column.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Scatter()].

Value

An 'echarts4r' htmlwidget.

Plot cluster sizes

Description

Plot cluster sizes

Usage

Plot.ClusterSizes(
  cluster_sizes,
  Title = "Cluster sizes",
  EchartsTheme = "macarons",
  ...
)

Arguments

cluster_sizes

Named or unnamed cluster counts.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Bar()].

Value

An 'echarts4r' htmlwidget.

Plot.ConfusionMatrix

Description

Generate variable importance plots

Usage

Plot.ConfusionMatrix(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_X = 50,
  NumLevels_Y = 50,
  Height = NULL,
  Width = NULL,
  Title = "Confusion Matrix",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "white",
  AggMethod = "count",
  GroupVar = NULL,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

FALSE
XVar

Column name of X-Axis variable. If NULL then ignored
YVar

Column name of Y-Axis variable. If NULL then ignored
ZVar

= "N"
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21,
NumLevels_X

= NumLevels_Y,
NumLevels_Y

= NumLevels_X,
Height

"400px"
Width

"200px"
Title

title
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

'darkblue'
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
GroupVar

= NULL
xaxis.rotate

numeric
yaxis.rotate

numeric
ContainLabel

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Copula

Description

Build a copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Copula(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Copula Plot",
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Requires an XVar and YVar already be defined
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

'Copula Plot'
ShowLabels

character
AddGLM

logical
Title.YAxis

character
Title.XAxis

character
EchartsTheme

= "dark-blue",
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
TextColor

'darkblue'
yaxis.fontSize

14
xaxis.fontSize

14
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts Copula Plot Chart
AutoPlots::Plot.Copula(
  dt = data,
  SampleSize = 10000,
  XVar = "Independent_Variable8",
  YVar = "Adrian",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = 'Copula Plot',
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "black",
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.Copula3D

Description

Build a 3D-copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Copula3D(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Copula 3D",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "dark-blue",
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  zaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
GroupVar

Requires an XVar and YVar already be defined
Height

"400px"
Width

"200px"
Title

'Copula3D Plot'
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

= "dark-blue"
TimeLine

Logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
zaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
zaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable9 := Independent_Variable9 * stats::runif(.N)]

# Echarts Copula Plot Chart
AutoPlots::Plot.Copula3D(
  dt = data,
  SampleSize = 10000,
  XVar = "Adrian",
  YVar = "Independent_Variable9",
  ZVar = "Independent_Variable6",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  Title = 'Copula 3D',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  zaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.CorrMatrix

Description

Build a correlation matrix plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.CorrMatrix(
  dt = NULL,
  CorrVars = NULL,
  CorrVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Method = "spearman",
  PreAgg = FALSE,
  MaxNAPercent = 0.05,
  Height = NULL,
  Width = NULL,
  Title = "Correlation Matrix",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
CorrVars

vector of variable names
CorrVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Method

character
PreAgg

logical
MaxNAPercent

numeric
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TextColor

character hex
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts CorrMatrix Plot Chart
AutoPlots::Plot.CorrMatrix(
  dt = data,
  CorrVars = c(
    "Adrian",
    "Independent_Variable1",
    "Independent_Variable2",
    "Independent_Variable3",
    "Independent_Variable4",
    "Independent_Variable5"),
  CorrVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Method = 'pearson',
  PreAgg = FALSE,
  MaxNAPercent = 0.05,
  Height = NULL,
  Width = NULL,
  Title = "Correlation Matrix",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  Debug = FALSE)

Plot.Density

Description

Density plots, by groups, with transparent continuous plots

Usage

Plot.Density(
  dt = NULL,
  SampleSize = 100000L,
  YVar = NULL,
  XVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  MouseScroll = TRUE,
  Title = "Density Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

= 100000L
YVar

Y-Axis variable name
XVar

X-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
Title

= "Density Plot"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

"white"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)))

# Create plot
AutoPlots::Plot.Density(
  dt = dt,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  EchartsTheme = "macarons",
  Title = "Histogram",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE)

Plot.Donut

Description

Build a donut plot by simply passing arguments to a single function

Usage

Plot.Donut(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Donut Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

'darkblue'
title.fontSize

Defaults to size 22. Numeric. This changes the size of the title.
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Plot.Donut(
  dt = dt,
  PreAgg = FALSE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  Title = 'Pie Chart',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE)

Plot component explained variance

Description

Plot component explained variance

Usage

Plot.ExplainedVariance(
  explained_variance,
  cumulative = NULL,
  Title = "Explained variance",
  EchartsTheme = "macarons",
  ...
)

Arguments

explained_variance

Numeric explained-variance proportions.
cumulative

Optional cumulative proportions.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Bar()].

Value

An 'echarts4r' htmlwidget.

Plot governed history, forecasts, and interval bounds

Description

Plot governed history, forecasts, and interval bounds

Usage

Plot.Forecast(
  dt,
  DateVar = "forecast_date",
  ActualVar = "actual",
  ForecastVar = "forecast",
  LowerVar = "lower_interval",
  UpperVar = "upper_interval",
  GroupVar = NULL,
  Title = "History and forecast",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Tabular forecast evidence.
DateVar

Ordered date/time column.
ActualVar

Optional observed-value column.
ForecastVar

Forecast column.
LowerVar, UpperVar

Optional predictive interval-bound columns.
GroupVar

Optional series/entity column.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot rolling-origin forecast errors by horizon

Description

Plot rolling-origin forecast errors by horizon

Usage

Plot.ForecastBacktest(
  dt,
  HorizonVar = "horizon",
  ValueVar = "value",
  MetricVar = "metric",
  Title = "Rolling-origin error by horizon",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Rolling-origin metrics containing horizon and metric values.
HorizonVar

Horizon column.
ValueVar

Metric-value column.
MetricVar

Optional metric-name column.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot nominal and empirical forecast coverage

Description

Plot nominal and empirical forecast coverage

Usage

Plot.ForecastCalibration(
  dt,
  NominalVar = "nominal_coverage",
  EmpiricalVar = "empirical_coverage",
  HorizonVar = NULL,
  Title = "Forecast interval calibration",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Calibration evidence.
NominalVar, EmpiricalVar

Nominal and empirical coverage columns.
HorizonVar

Optional horizon column.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot component forecasts and their governed combination

Description

Plot component forecasts and their governed combination

Usage

Plot.ForecastCombination(
  dt,
  HorizonVar = "horizon",
  ForecastVar = "forecast",
  ComponentVar = "component_id",
  Title = "Forecast components and combination",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Long component/combination forecast evidence.
HorizonVar, ForecastVar, ComponentVar

Column names.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot MSTL decomposition components

Description

Plot MSTL decomposition components

Usage

Plot.ForecastDecomposition(
  dt,
  ObservationVar = "observation",
  ComponentVars = NULL,
  Title = "MSTL decomposition",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Wide MSTL component evidence.
ObservationVar

Observation index column.
ComponentVars

Optional component columns.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Compare base and reconciled forecasts

Description

Compare base and reconciled forecasts

Usage

Plot.ForecastReconciliation(
  dt,
  DateVar = "forecast_date",
  BaseVar = "base_forecast",
  ReconciledVar = "reconciled_forecast",
  GroupVar = NULL,
  Title = "Base and reconciled forecast",
  EchartsTheme = "macarons",
  ...
)

Arguments

dt

Reconciliation evidence.
DateVar

Ordered date/time column.
BaseVar

Base forecast column.
ReconciledVar

Reconciled forecast column.
GroupVar

Optional hierarchy/entity column.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot.Gains

Description

Create a cumulative gains chart

Usage

Plot.Gains(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  Title = "Gains Plot",
  ShowLabels = FALSE,
  Title.YAxis = "Gain",
  Title.XAxis = "Population",
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

NULL
Width

NULL
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

character hex
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.HeatMap

Description

Create heat maps with numeric or categorical dt

Usage

Plot.HeatMap(
  dt,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Title = "Heatmap",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "dark",
  MouseScroll = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

'mean', 'median', 'sum', 'sd', 'coeffvar', 'count'
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_Y

= 20
NumLevels_X

= 20.
Height

"400px"
Width

"200px"
Title

"Heatmap"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"dark-blue"
MouseScroll

logical, zoom via mouse scroll
TextColor

color
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging parameter

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts Heatmap Plot Chart
AutoPlots::Plot.HeatMap(
  dt = data,
  PreAgg = FALSE,
  XVar = "Factor_1",
  YVar = "Factor_2",
  ZVar = "Independent_Variable6",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_Y = 33,
  NumLevels_X = 33,
  Height = NULL,
  Width = NULL,
  Title = "Heatmap",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.Histogram

Description

Build a histogram plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Histogram(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 30,
  Height = NULL,
  Width = NULL,
  EchartsTheme = "macarons",
  Title = "Histogram",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 30
Height

"400px"
Width

"200px"
EchartsTheme

= EchartsTheme,
Title

character
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
ShowLabels

FALSE
Title.YAxis

NULL
Title.XAxis

NULL
TextColor

"white"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)))

# Create plot
AutoPlots::Plot.Histogram(
  dt = dt,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 30,
  Height = NULL,
  Width = NULL,
  EchartsTheme = "macarons",
  Title = "Histogram",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE)

Plot.Lift

Description

Create a cumulative gains chart

Usage

Plot.Lift(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  ZVar = "N",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  Title = "Confusion Matrix",
  ShowLabels = FALSE,
  Title.YAxis = "Lift",
  Title.XAxis = "Population",
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

character hex
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Line

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.Line(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Line Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  Area = FALSE,
  Alpha = 0.5,
  Smooth = TRUE,
  ShowSymbol = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  DarkMode = FALSE,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

NULL
Width

NULL
Title

"Title"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

Provide an "Echarts" theme
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
Area

logical
Alpha

0 to 1 for setting transparency
Smooth

= TRUE
ShowSymbol

= FALSE
TextColor

"Not Implemented"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
DarkMode

FALSE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build Line plot
AutoPlots::Plot.Line(
  dt = data,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "LogPlus1",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "LogPlus1",
  GroupVar = NULL,
  EchartsTheme = "macarons")

Plot modeled-field missingness rates

Description

Plot modeled-field missingness rates

Usage

Plot.MissingnessRates(
  missing_rates,
  Title = "Missingness by field",
  EchartsTheme = "macarons",
  ...
)

Arguments

missing_rates

Named numeric proportions.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Bar()].

Value

An 'echarts4r' htmlwidget.

Plot ordered nearest-neighbor distances

Description

Plot ordered nearest-neighbor distances

Usage

Plot.NeighborDistances(
  distances,
  Title = "Neighbor distances",
  EchartsTheme = "macarons",
  ...
)

Arguments

distances

Numeric neighbor distances.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot.PACF

Description

Build a partial autocorrelation plot by simply passing arguments to a single function

Usage

Plot.PACF(
  dt = NULL,
  YVar = NULL,
  DateVar = NULL,
  TimeUnit = NULL,
  MaxLags = 50,
  YVarTrans = "Identity",
  AggMethod = "sum",
  Height = NULL,
  Width = NULL,
  Title = "Partial Autocorrelation Plot",
  EchartsTheme = "macarons",
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
DateVar

Date column in data
TimeUnit

Select from "hour", "day", "week", "month", "quarter", "year"
MaxLags

Max value for lags to test
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Plot.Parallel

Description

Build a parallel plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Parallel(
  dt = NULL,
  SampleSize = 50000,
  CorrVars = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  PreAgg = FALSE,
  Height = NULL,
  Width = NULL,
  Title = "Parallel Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

Sample size
CorrVars

vector of variable names
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
PreAgg

logical
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TextColor

character hex
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create data
dt = AutoPlots::FakeDataGenerator(N = 100000)

# Create plot
AutoPlots::Plot.Parallel(
  dt = dt,
  SampleSize = 1000,
  CorrVars = c("Independent_Variable3",
               "Independent_Variable4",
               "Independent_Variable5",
               "Independent_Variable6",
               "Independent_Variable7"),
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Parallel Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  Debug = FALSE)

Plot.PartialDependence.Box

Description

This function automatically builds partial dependence calibration plots

Usage

Plot.PartialDependence.Box(
  dt = NULL,
  PreAgg = FALSE,
  SampleSize = 100000L,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Partial Dependence Box",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  EchartsLabels = FALSE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
EchartsLabels

character
TimeLine

logical
TextColor

hex character
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.PartialDependence.HeatMap

Description

This function automatically builds partial dependence calibration plots

Usage

Plot.PartialDependence.HeatMap(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Partial Dependence Heatmap",
  ShowLabels = FALSE,
  MouseScroll = TRUE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  EchartsLabels = FALSE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
MouseScroll

logical, zoom via mouse scroll
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
EchartsLabels

character
TimeLine

logical
TextColor

hex character
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.PartialDependence.Line

Description

This function automatically builds partial dependence calibration plots

Usage

Plot.PartialDependence.Line(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  NumberBins = 20,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Partial Dependence Line",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  EchartsLabels = FALSE,
  TimeLine = TRUE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

character
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
GroupVar

Character variable
NumberBins

numeric
AggMethod

character
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
EchartsLabels

character
TimeLine

logical
TextColor

hex character
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Pie

Description

Build a pie chart by simply passing arguments to a single function

Usage

Plot.Pie(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Pie Chart",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Plot.Pie(
  dt = dt,
  PreAgg = FALSE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  Title = 'Pie Chart',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE)

Plot.ProbabilityPlot

Description

Build a normal probability plot

Usage

Plot.ProbabilityPlot(
  dt = NULL,
  SampleSize = 1000L,
  YVar = NULL,
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  Title = "Normal Probability Plot",
  ShowLabels = FALSE,
  EchartsTheme = "macarons",
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  tooltip.trigger = "axis",
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
YVar

Y-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
Height

"400px"
Width

"200px"
Title

'Violin Plot'
ShowLabels

character
EchartsTheme

"macaron"
TextColor

'darkblue'
title.fontSize

Default 22
title.fontWeight

Default "bold"
title.textShadowColor

Default '#63aeff'
title.textShadowBlur

Default 3
title.textShadowOffsetY

Default 1
title.textShadowOffsetX

Default -1
yaxis.fontSize

Default 14
yaxis.rotate

Default 0
ContainLabel

Default TRUE
tooltip.trigger

Default "axis"
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)))

# Create plot
AutoPlots::Plot.ProbabilityPlot(
  dt = dt,
  SampleSize = 1000L,
  YVar = "Y",
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  Title = 'Normal Probability Plot',
  ShowLabels = FALSE,
  EchartsTheme = "blue",
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  tooltip.trigger = "axis",
  Debug = FALSE)

Plot.prROC

Description

ROC Plot

Usage

Plot.prROC(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "ROC Plot",
  ShowLabels = FALSE,
  Title.YAxis = "True Positive Rate",
  Title.XAxis = "1 - False Positive Rate",
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

character
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

character hex
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Radar

Description

Plot.Radar

Usage

Plot.Radar(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  Title = "Radar Plot",
  ShowLabels = FALSE,
  EchartsTheme = "macarons",
  ShowSymbol = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  ContainLabel = TRUE,
  DarkMode = FALSE,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
YVar

Y-Axis variable name. You can supply multiple YVars
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
Height

"400px"
Width

"200px"
Title

"Title"
ShowLabels

character
EchartsTheme

Provide an "Echarts" theme
ShowSymbol

= FALSE
TextColor

"Not Implemented"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
ContainLabel

TRUE
DarkMode

FALSE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create Data
dt <- data.table::data.table(Y = pnorm(q = stats::runif(8)), GV = sample(LETTERS[1:4], 8, TRUE))

# Create plot
AutoPlots::Plot.Radar(
  dt = dt,
  AggMethod = "mean",
  PreAgg = FALSE,
  YVar = "Y",
  GroupVar = "GV",
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  Title = 'Radar Plot',
  ShowLabels = FALSE,
  EchartsTheme = "macarons",
  ShowSymbol = FALSE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  ContainLabel = TRUE,
  DarkMode = FALSE,
  Debug = FALSE)

Plot.Residuals.Histogram

Description

Residuals Plot

Usage

Plot.Residuals.Histogram(
  dt = NULL,
  AggMethod = "mean",
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  Title = "Residuals Histogram",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = "Target - Predicted",
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

Not Implemented
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Residuals.Scatter

Description

Residuals_2 Plot

Usage

Plot.Residuals.Scatter(
  dt = NULL,
  AggMethod = "mean",
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  MouseScroll = TRUE,
  Title = "Residual Scatterplot",
  ShowLabels = FALSE,
  Title.YAxis = "Target - Predicted",
  Title.XAxis = "Predicted",
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

"Not Implemented"
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.River

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.River(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "River Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  ShowSymbol = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

"Title"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

Provide an "Echarts" theme
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
ShowSymbol

= FALSE
TextColor

"Not Implemented"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build plot
AutoPlots::Plot.River(
  dt = data,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = c(
    "Independent_Variable1",
    "Independent_Variable2",
    "Independent_Variable3",
    "Independent_Variable4",
    "Independent_Variable5"),
  YVarTrans = "Identity",
  TextColor = "black",
  EchartsTheme = "macarons")

Plot.ROC

Description

ROC Plot

Usage

Plot.ROC(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "ROC Plot",
  ShowLabels = FALSE,
  Title.YAxis = "True Positive Rate",
  Title.XAxis = "1 - False Positive Rate",
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

character
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

character hex
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.Rosetype

Description

Build a donut plot by simply passing arguments to a single function

Usage

Plot.Rosetype(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Donut Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

'darkblue'
title.fontSize

Defaults to size 22. Numeric. This changes the size of the title.
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = stats::runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Plot.Rosetype(
  dt = dt,
  PreAgg = FALSE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  Title = 'Pie Chart',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE)

Plot.Scatter

Description

Build a copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Scatter(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Scatter Plot",
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  tooltip.trigger = "axis",
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

character
ShowLabels

character
AddGLM

logical
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

character hex
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
tooltip.trigger

"axis"
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable8 := Independent_Variable8 * stats::runif(.N)]

# Echarts Scatter Plot Chart
AutoPlots::Plot.Scatter(
  dt = data,
  SampleSize = 10000,
  XVar = "Independent_Variable10",
  YVar = "Independent_Variable8",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = 'Scatter Plot',
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "blue",
  MouseScroll = TRUE,
  TimeLine = FALSE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  tooltip.trigger = "axis",
  Debug = FALSE)

Plot.Scatter3D

Description

Build a 3D-copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Plot.Scatter3D(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "3D Scatter",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  zaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
GroupVar

Requires an XVar and YVar already be defined
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

'Violin Plot'
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

= "macaron"
TimeLine

Logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
zaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
zaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable9 := Independent_Variable9 * stats::runif(.N)]

# Echarts Copula Plot Chart
AutoPlots::Plot.Scatter3D(
  dt = data,
  SampleSize = 10000,
  XVar = "Adrian",
  YVar = "Independent_Variable9",
  ZVar = "Independent_Variable6",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  Title = 'Copula 3D',
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = FALSE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  zaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  zaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.ShapImportance

Description

Plot.ShapImportance variable importance

Usage

Plot.ShapImportance(
  dt,
  PreAgg = FALSE,
  AggMethod = "meanabs",
  YVar = NULL,
  GroupVar = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_X = 33,
  NumLevels_Y = 33,
  Height = NULL,
  Width = NULL,
  Title = "Shap Importance",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "dark",
  TextColor = "white",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

"mean", "median", "sum", "sd", "skewness","kurtosis", "coeffvar", "meanabs", "medianabs", "sumabs", "sdabs", "skewnessabs", "kurtosisabs", "CoeffVarabs"
YVar

Names of shap columns
GroupVar

Name of by variable
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_X

= 20
NumLevels_Y

= 20
Height

"400px"
Width

"200px"
Title

"Heatmap"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"dark-blue"
TextColor

character
Debug

= FALSE

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.StackedBar

Description

Build a stacked bar plot vs a grouped bar plot

Usage

Plot.StackedBar(
  dt = NULL,
  PreAgg = FALSE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Stacked Bar",
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  ShowLabels = FALSE,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

NULL
Width

NULL
Title

title
Title.YAxis

NULL. If NULL, YVar name will be used
Title.XAxis

NULL. If NULL, XVar name will be used
ShowLabels

logical
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
yaxis.fontSize

14
xaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)

# Echarts Stacked Bar Chart
AutoPlots::Plot.StackedBar(
  dt = data,
  PreAgg = FALSE,
  XVar = "Factor_1",
  YVar = "Adrian",
  GroupVar = "Factor_2",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  Title = "Stacked Bar",
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  ShowLabels = FALSE,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  yaxis.fontSize = 14,
  xaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plot.StandardPlots

Description

Helper for standard plots

Usage

Plot.StandardPlots(
  dt = NULL,
  PreAgg = FALSE,
  PlotType = "Scatter",
  SampleSize = 100000L,
  AggMethod = "mean",
  NumberBins = 30,
  YVar = NULL,
  DualYVar = NULL,
  XVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = NULL,
  DualYVarTrans = NULL,
  XVarTrans = NULL,
  ZVarTrans = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  EchartsTheme = "dark-blue",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  Title = NULL,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  NumLevels_Y = 75,
  NumLevels_X = 40,
  TextColor = "white",
  FontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

FALSE
PlotType

character
SampleSize

character
AggMethod

character
NumberBins

For histograms
YVar

Y-Axis variable name
DualYVar

Secondary Axis for Line, Step, and Area plots
XVar

X-Axis variable name
ZVar

Z-Axis variable name
GroupVar

Character variable variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

NULL or valid css unit
Width

NULL or valid css unit
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

character
Title

character
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
NumLevels_Y

Numeric
NumLevels_X

Numeric
TextColor

character
FontSize

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Auto Plotting: Plots.ModelEvaluation()

Plot.Step

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Plot.Step(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Line Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  MouseScroll = TRUE,
  TimeLine = TRUE,
  ShowSymbol = FALSE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
Title

"Title"
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

Provide an "Echarts" theme
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
ShowSymbol

= FALSE
TextColor

"Not Implemented"
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build plot
AutoPlots::Plot.Step(
  dt = data,
  PreAgg = FALSE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "Identity",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "Identity",
  GroupVar = NULL,
  EchartsTheme = "macarons")

Plot a temporal signal with governed event markers

Description

Plot a temporal signal with governed event markers

Usage

Plot.TemporalEvents(
  time,
  value,
  events = integer(),
  event_label = "Detected event",
  Title = "Temporal diagnostics",
  EchartsTheme = "macarons",
  ...
)

Arguments

time, value

Ordered time and numeric values.
events

Optional positions marking motifs, discords, anomalies, or changes.
event_label

Legend label for event markers.
Title

Plot title.
EchartsTheme

AutoPlots theme.
...

Additional arguments passed to [Line()].

Value

An 'echarts4r' htmlwidget.

Plot.VariableImportance

Description

Generate variable importance plots

Usage

Plot.VariableImportance(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  Title = "Variable Importance Plot",
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "macarons",
  TimeLine = TRUE,
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

Column name of X-Axis variable. If NULL then ignored
YVar

Column name of Y-Axis variable. If NULL then ignored
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
Title

title
ShowLabels

character
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

'darkblue'
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Plot.WordCloud

Description

WordCloud plots

Usage

Plot.WordCloud(
  dt = NULL,
  YVar = NULL,
  Height = NULL,
  Width = NULL,
  Title = "Word Cloud",
  EchartsTheme = "macarons",
  TextColor = "white",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = "#63aeff",
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
Height

"400px"
Width

"200px"
Title

= "Density Plot"
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TextColor

"white",
title.fontSize

22
title.fontWeight

"bold"
title.textShadowColor

'#63aeff'
title.textShadowBlur

3
title.textShadowOffsetY

1
title.textShadowOffsetX

-1
xaxis.fontSize

14
yaxis.fontSize

14
xaxis.rotate

0
yaxis.rotate

0
ContainLabel

TRUE
Debug

Debugging purposes

Value

plot

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- FakeDataGenerator(AddComment = TRUE)

# Create plot
AutoPlots::Plot.WordCloud(
  dt = dt,
  YVar = "Comment",
  Height = NULL,
  Width = NULL,
  Title = "Word Cloud",
  EchartsTheme = "macarons",
  TextColor = "black",
  title.fontSize = 22,
  title.fontWeight = "bold",
  title.textShadowColor = '#63aeff',
  title.textShadowBlur = 3,
  title.textShadowOffsetY = 1,
  title.textShadowOffsetX = -1,
  xaxis.fontSize = 14,
  yaxis.fontSize = 14,
  xaxis.rotate = 0,
  yaxis.rotate = 0,
  ContainLabel = TRUE,
  Debug = FALSE)

Plots.ModelEvaluation

Description

Plot helper for model evaluation plot types

Usage

Plots.ModelEvaluation(
  dt = NULL,
  AggMethod = "mean",
  SampleSize = 100000L,
  PlotType = NULL,
  YVar = NULL,
  TargetLevel = NULL,
  ZVar = NULL,
  XVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumLevels_Y = 75,
  NumLevels_X = 40,
  MouseScroll = FALSE,
  Height = NULL,
  Width = NULL,
  Title = NULL,
  ShowLabels = FALSE,
  Title.YAxis = NULL,
  Title.XAxis = NULL,
  EchartsTheme = "dark-blue",
  TimeLine = FALSE,
  TextColor = "white",
  FontSize = 14L,
  NumberBins = 20,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
SampleSize

100000L
PlotType

character
YVar

Y-Axis variable name
TargetLevel

character
ZVar

Z-Axis variable name
XVar

X-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumLevels_Y

= 75
NumLevels_X

= 40
MouseScroll

logical, zoom via mouse scroll
Height

"400px"
Width

"200px"
Title

character
ShowLabels

logical
Title.YAxis

character
Title.XAxis

character
EchartsTheme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo", #' "essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired", #' "jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal", #' "sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
TextColor

hex
FontSize

numeric
NumberBins

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Auto Plotting: Plot.StandardPlots()

ProbabilityPlot

Description

Build a normal probability plot

Usage

ProbabilityPlot(
  dt = NULL,
  SampleSize = 1000L,
  YVar = NULL,
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  title.text = "Probability Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
YVar

Y-Axis variable name
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)))

# Create plot
AutoPlots::ProbabilityPlot(
  dt = dt,
  SampleSize = 1000L,
  YVar = "Y",
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "blue",
  Debug = FALSE)

Run AutoPlots installed-package QA

Description

Runs the stable installed-package QA contract for AutoPlots. This public entry point validates representative rendering and layout contracts while keeping implementation-specific QA helpers internal.

Usage

qa_autoplots_package()

Value

A data.table with QA check rows and normalized status values.

Examples

## Not run: 
qa_autoplots_package()

## End(Not run)

Radar

Description

Radar

Usage

Radar(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  ShowSymbol = FALSE,
  DarkMode = FALSE,
  lineStyle.color = NULL,
  title.text = "Radar Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "item",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
YVar

Y-Axis variable name. You can supply multiple YVars
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
ShowSymbol

= FALSE
DarkMode

FALSE
lineStyle.color

hex or name for radar lines
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create Data
dt <- data.table::data.table(Y = pnorm(q = runif(8)), GV = sample(LETTERS[1:4], 8, TRUE))

# Create plot
AutoPlots::Radar(
  dt = dt,
  AggMethod = "mean",
  PreAgg = TRUE,
  YVar = "Y",
  GroupVar = "GV",
  YVarTrans = "Identity",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  ShowSymbol = FALSE,

  DarkMode = FALSE,
  Debug = FALSE)

Residuals.Histogram

Description

Residuals Plot

Usage

Residuals.Histogram(
  dt = NULL,
  AggMethod = "mean",
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 20,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

numeric
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Residuals.Scatter

Description

Residuals_2 Plot

Usage

Residuals.Scatter(
  dt = NULL,
  AggMethod = "mean",
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  MouseScroll = FALSE,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
MouseScroll

logical, zoom via mouse scroll
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), ShapImportance(), VariableImportance()

River

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

River(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  ShowSymbol = FALSE,
  itemStyle.color = NULL,
  title.text = "River Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 30,
  legend.top = 45,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = FALSE,
  toolbox.feature.dataZoom.show = FALSE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
ShowSymbol

= FALSE
itemStyle.color

color or hex
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

dates <- seq.Date(Sys.Date() - 30, Sys.Date(), by = "day")
grps <- lapply(LETTERS[1:5], rep, 31) |> unlist()
dt <- data.table::data.table(
  dates = rep(dates, 5),
  groups = grps,
  values = runif(length(grps), 1, 50)
)

# Build Plot
AutoPlots::River(
  dt = dt,
  PreAgg = TRUE,
  XVar = "dates",
  YVar = "values",
  GroupVar = "groups",
  legend.orient = "horizontal",
  itemStyle.color = c("#FF4C4C", "#00BFFF", "#FFD700", "#32CD32", "#FF69B4")
)

ROC

Description

ROC Plot

Usage

ROC(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = NULL,
  yAxis.title = NULL,
  xAxis.title = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

character
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance(), VariableImportance()

Rosetype

Description

Build a donut plot by simply passing arguments to a single function

Usage

Rosetype(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = TRUE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = "Rosetype Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "item",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = FALSE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus","azul","bee-inspired","blue","caravan","carp","chalk","cool","dark-bold","dark","eduardo","essos","forest","fresh-cut","fruit","gray","green","halloween","helianthus","infographic","inspired","jazz","london","dark","macarons","macarons2","mint","purple-passion","red-velvet","red","roma","royal","sakura","shine","tech-blue","vintage","walden","wef","weforum","westeros","wonderland"
TimeLine

logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Scatter(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = runif(10000)), GV = sample(LETTERS, 1000, TRUE))

# Create plot
AutoPlots::Rosetype(
  dt = dt,
  PreAgg = TRUE,
  XVar = "GV",
  YVar = "Y",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  Debug = FALSE)

Save plot as image

Description

Save plot as image

Usage

save_image(plot, path, name, height = 1027, width = 1500, delay = 1, zoom = 2)

Arguments

plot

A plot object or display_plot_grid object
path

Directory to save image
name

name of output image. name only
height

Default 1027 good for PowerPoint
width

Default 1500 good for PowerPoint
delay

Default 1 good for PowerPoint
zoom

Default 2 good for PowerPoint

Value

A browsable HTML grid for use in Rmarkdown, Shiny, or viewer pane.

Scatter

Description

Build a copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Scatter(
  dt = NULL,
  SampleSize = 30000L,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = "Scatter Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

numeric
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Character variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
AddGLM

logical
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter3D(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable8 := Independent_Variable8 * runif(.N)]

# Echarts Scatter Plot Chart
AutoPlots::Scatter(
  dt = data,
  SampleSize = 10000,
  XVar = "Independent_Variable10",
  YVar = "Independent_Variable8",
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  AddGLM = FALSE,
  Theme = "blue",
  MouseScroll = FALSE,
  TimeLine = FALSE,

  Debug = FALSE)

Scatter3D

Description

Build a 3D-copula plot by simply passing arguments to a single function. It will sample your data using SampleSize number of rows. Sampled data is randomized.

Usage

Scatter3D(
  dt = NULL,
  SampleSize = 1e+05,
  XVar = NULL,
  YVar = NULL,
  ZVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = "3D Scatter Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
SampleSize

An integer for the number of rows to use. Sampled data is randomized. If NULL then ignored
XVar

X-Axis variable name
YVar

Y-Axis variable name
ZVar

Z-Axis variable name
GroupVar

Requires an XVar and YVar already be defined
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
ZVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

Logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), StackedBar(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 100000)
data[, Independent_Variable9 := Independent_Variable9 * runif(.N)]

# Echarts Copula Plot Chart
AutoPlots::Scatter3D(
  dt = data,
  SampleSize = 10000,
  XVar = "Adrian",
  YVar = "Independent_Variable9",
  ZVar = "Independent_Variable6",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  ZVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  GroupVar = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,

  Debug = FALSE)

ShapImportance

Description

ShapImportance variable importance

Usage

ShapImportance(
  dt,
  PreAgg = TRUE,
  AggMethod = "meanabs",
  YVar = NULL,
  GroupVar = NULL,
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  NumberBins = 21,
  NumLevels_X = 33,
  NumLevels_Y = 33,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
AggMethod

"mean", "median", "sum", "sd", "skewness","kurtosis", "coeffvar", "meanabs", "medianabs", "sumabs", "sdabs", "skewnessabs", "kurtosisabs", "CoeffVarabs"
YVar

Names of shap columns
GroupVar

Name of by variable
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
NumberBins

= 21
NumLevels_X

= 20
NumLevels_Y

= 20
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
Debug

= FALSE

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), VariableImportance()

StackedBar

Description

Build a stacked bar plot vs a grouped bar plot

Usage

StackedBar(
  dt = NULL,
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  title.text = "Stacked Bar Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

NULL
Width

NULL
ShowLabels

logical
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

logical
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), Step(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 10000)

# Echarts Stacked Bar Chart
AutoPlots::StackedBar(
  dt = data,
  PreAgg = TRUE,
  XVar = "Factor_1",
  YVar = "Adrian",
  GroupVar = "Factor_2",
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = 'mean',
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,

  Debug = FALSE)

Step

Description

This function automatically builds calibration plots and calibration boxplots for model evaluation using regression, stats::quantile regression, and binary and multinomial classification

Usage

Step(
  dt = NULL,
  AggMethod = "mean",
  PreAgg = TRUE,
  XVar = NULL,
  YVar = NULL,
  DualYVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  DualYVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  MouseScroll = FALSE,
  TimeLine = FALSE,
  ShowSymbol = FALSE,
  lineStyle.color = NULL,
  lineStyle.width = NULL,
  lineStyle.type = NULL,
  lineStyle.shadowColor = NULL,
  lineStyle.shadowBlur = NULL,
  lineStyle.shadowOffsetX = NULL,
  lineStyle.shadowOffsetY = NULL,
  title.text = "Step Plot",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  xAxis.title = NULL,
  xAxis.min = NULL,
  xAxis.max = NULL,
  xAxis.position = "bottom",
  xAxis.nameLocation = "center",
  xAxis.axisTick.customValues = NULL,
  xAxis.nameTextStyle.color = NULL,
  xAxis.nameTextStyle.padding = 25,
  xAxis.nameTextStyle.align = NULL,
  xAxis.nameTextStyle.fontStyle = NULL,
  xAxis.nameTextStyle.fontWeight = "bolder",
  xAxis.nameTextStyle.fontSize = NULL,
  xAxis.nameTextStyle.fontFamily = "Segoe UI",
  xAxis.nameTextStyle.textShadowColor = NULL,
  xAxis.nameTextStyle.textShadowBlur = NULL,
  xAxis.nameTextStyle.textShadowOffsetX = NULL,
  xAxis.nameTextStyle.textShadowOffsetY = NULL,
  xAxis.splitNumber = NULL,
  xAxis.axisLabel.rotate = NULL,
  xAxis.axisLabel.margin = NULL,
  xAxis.axisLabel.color = NULL,
  xAxis.axisLabel.fontStyle = NULL,
  xAxis.axisLabel.fontWeight = NULL,
  xAxis.axisLabel.fontFamily = "Segoe UI",
  xAxis.axisLabel.fontSize = 14,
  xAxis.axisLabel.align = NULL,
  xAxis.axisLabel.verticalAlign = NULL,
  xAxis.axisLabel.backgroundColor = NULL,
  xAxis.axisLabel.borderColor = NULL,
  xAxis.axisLabel.borderWidth = NULL,
  xAxis.axisLabel.borderType = NULL,
  xAxis.axisLabel.borderRadius = NULL,
  xAxis.axisLabel.padding = NULL,
  xAxis.axisLabel.shadowColor = NULL,
  xAxis.axisLabel.shadowBlur = NULL,
  xAxis.axisLabel.shadowOffsetX = NULL,
  xAxis.axisLabel.shadowOffsetY = NULL,
  xAxis.axisLabel.textBorderColor = NULL,
  xAxis.axisLabel.textBorderWidth = NULL,
  xAxis.axisLabel.textBorderType = NULL,
  xAxis.axisLabel.textShadowColor = NULL,
  xAxis.axisLabel.textShadowBlur = NULL,
  xAxis.axisLabel.textShadowOffsetX = NULL,
  xAxis.axisLabel.textShadowOffsetY = NULL,
  xAxis.axisLabel.overflow = NULL,
  yAxis.title = NULL,
  yAxis.min = NULL,
  yAxis.max = NULL,
  yAxis.position = "center",
  yAxis.nameLocation = "center",
  yAxis.axisTick.customValues = NULL,
  yAxis.nameTextStyle.color = NULL,
  yAxis.nameTextStyle.padding = 25,
  yAxis.nameTextStyle.align = NULL,
  yAxis.nameTextStyle.fontStyle = NULL,
  yAxis.nameTextStyle.fontWeight = "bolder",
  yAxis.nameTextStyle.fontSize = NULL,
  yAxis.nameTextStyle.fontFamily = "Segoe UI",
  yAxis.nameTextStyle.textShadowColor = NULL,
  yAxis.nameTextStyle.textShadowBlur = NULL,
  yAxis.nameTextStyle.textShadowOffsetX = NULL,
  yAxis.nameTextStyle.textShadowOffsetY = NULL,
  yAxis.splitNumber = NULL,
  yAxis.axisLabel.rotate = NULL,
  yAxis.axisLabel.margin = NULL,
  yAxis.axisLabel.color = NULL,
  yAxis.axisLabel.fontStyle = NULL,
  yAxis.axisLabel.fontWeight = NULL,
  yAxis.axisLabel.fontFamily = "Segoe UI",
  yAxis.axisLabel.fontSize = 14,
  yAxis.axisLabel.align = NULL,
  yAxis.axisLabel.verticalAlign = NULL,
  yAxis.axisLabel.backgroundColor = NULL,
  yAxis.axisLabel.borderColor = NULL,
  yAxis.axisLabel.borderWidth = NULL,
  yAxis.axisLabel.borderType = NULL,
  yAxis.axisLabel.borderRadius = NULL,
  yAxis.axisLabel.padding = NULL,
  yAxis.axisLabel.shadowColor = NULL,
  yAxis.axisLabel.shadowBlur = NULL,
  yAxis.axisLabel.shadowOffsetX = NULL,
  yAxis.axisLabel.shadowOffsetY = NULL,
  yAxis.axisLabel.textBorderColor = NULL,
  yAxis.axisLabel.textBorderWidth = NULL,
  yAxis.axisLabel.textBorderType = NULL,
  yAxis.axisLabel.textShadowColor = NULL,
  yAxis.axisLabel.textShadowBlur = NULL,
  yAxis.axisLabel.textShadowOffsetX = NULL,
  yAxis.axisLabel.textShadowOffsetY = NULL,
  yAxis.axisLabel.overflow = NULL,
  legend.show = TRUE,
  legend.type = "scroll",
  legend.selector = NULL,
  legend.icon = NULL,
  legend.align = NULL,
  legend.padding = NULL,
  legend.itemGap = NULL,
  legend.itemWidth = NULL,
  legend.orient = "vertical",
  legend.width = NULL,
  legend.height = NULL,
  legend.left = NULL,
  legend.right = 10,
  legend.top = 30,
  legend.bottom = NULL,
  legend.backgroundColor = NULL,
  legend.borderColor = NULL,
  legend.borderWidth = NULL,
  legend.borderRadius = NULL,
  legend.shadowBlur = NULL,
  legend.shadowColor = NULL,
  legend.shadowOffsetX = NULL,
  legend.shadowOffsetY = NULL,
  legend.itemStyle.color = NULL,
  legend.itemStyle.borderColor = NULL,
  legend.itemStyle.borderWidth = NULL,
  legend.itemStyle.borderType = NULL,
  legend.itemStyle.shadowBlur = NULL,
  legend.itemStyle.shadowColor = NULL,
  legend.itemStyle.shadowOffsetX = NULL,
  legend.itemStyle.shadowOffsetY = NULL,
  legend.itemStyle.opacity = NULL,
  legend.lineStyle.color = NULL,
  legend.lineStyle.width = NULL,
  legend.lineStyle.type = NULL,
  legend.lineStyle.shadowBlur = NULL,
  legend.lineStyle.shadowColor = NULL,
  legend.lineStyle.shadowOffsetX = NULL,
  legend.lineStyle.shadowOffsetY = NULL,
  legend.lineStyle.opacity = NULL,
  legend.lineStyle.inactiveColor = NULL,
  legend.lineStyle.inactiveWidth = NULL,
  legend.textStyle.color = NULL,
  legend.textStyle.fontStyle = NULL,
  legend.textStyle.fontWeight = NULL,
  legend.textStyle.fontFamily = "Segoe UI",
  legend.textStyle.fontSize = NULL,
  legend.textStyle.backgroundColor = NULL,
  legend.textStyle.borderColor = NULL,
  legend.textStyle.borderWidth = NULL,
  legend.textStyle.borderType = NULL,
  legend.textStyle.borderRadius = NULL,
  legend.textStyle.padding = NULL,
  legend.textStyle.shadowColor = NULL,
  legend.textStyle.shadowBlur = NULL,
  legend.textStyle.shadowOffsetX = NULL,
  legend.textStyle.shadowOffsetY = NULL,
  legend.textStyle.width = NULL,
  legend.textStyle.height = NULL,
  legend.textStyle.textBorderColor = NULL,
  legend.textStyle.textBorderWidth = NULL,
  legend.textStyle.textBorderType = NULL,
  legend.textStyle.textShadowColor = NULL,
  legend.textStyle.textShadowBlur = NULL,
  legend.textStyle.textShadowOffsetX = NULL,
  legend.textStyle.textShadowOffsetY = NULL,
  legend.pageTextStyle.color = NULL,
  legend.pageTextStyle.fontStyle = NULL,
  legend.pageTextStyle.fontWeight = NULL,
  legend.pageTextStyle.fontFamily = "Segoe UI",
  legend.pageTextStyle.fontSize = NULL,
  legend.pageTextStyle.lineHeight = NULL,
  legend.pageTextStyle.width = NULL,
  legend.pageTextStyle.height = NULL,
  legend.pageTextStyle.textBorderColor = NULL,
  legend.pageTextStyle.textBorderWidth = NULL,
  legend.pageTextStyle.textBorderType = NULL,
  legend.pageTextStyle.textShadowColor = NULL,
  legend.pageTextStyle.textShadowBlur = NULL,
  legend.pageTextStyle.textShadowOffsetX = NULL,
  legend.pageTextStyle.textShadowOffsetY = NULL,
  legend.emphasis.selectorLabel.show = NULL,
  legend.emphasis.selectorLabel.distance = NULL,
  legend.emphasis.selectorLabel.rotate = NULL,
  legend.emphasis.selectorLabel.color = NULL,
  legend.emphasis.selectorLabel.fontStyle = NULL,
  legend.emphasis.selectorLabel.fontWeight = NULL,
  legend.emphasis.selectorLabel.fontFamily = "Segoe UI",
  legend.emphasis.selectorLabel.fontSize = NULL,
  legend.emphasis.selectorLabel.align = NULL,
  legend.emphasis.selectorLabel.verticalAlign = NULL,
  legend.emphasis.selectorLabel.lineHeight = NULL,
  legend.emphasis.selectorLabel.backgroundColor = NULL,
  legend.emphasis.selectorLabel.borderColor = NULL,
  legend.emphasis.selectorLabel.borderWidth = NULL,
  legend.emphasis.selectorLabel.borderType = NULL,
  legend.emphasis.selectorLabel.borderRadius = NULL,
  legend.emphasis.selectorLabel.padding = NULL,
  legend.emphasis.selectorLabel.shadowColor = NULL,
  legend.emphasis.selectorLabel.shadowBlur = NULL,
  legend.emphasis.selectorLabel.shadowOffsetX = NULL,
  legend.emphasis.selectorLabel.shadowOffsetY = NULL,
  legend.emphasis.selectorLabel.width = NULL,
  legend.emphasis.selectorLabel.height = NULL,
  legend.emphasis.selectorLabel.textBorderColor = NULL,
  legend.emphasis.selectorLabel.textBorderWidth = NULL,
  legend.emphasis.selectorLabel.textBorderType = NULL,
  legend.emphasis.selectorLabel.textShadowColor = NULL,
  legend.emphasis.selectorLabel.textShadowBlur = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetX = NULL,
  legend.emphasis.selectorLabel.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "axis",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = "cross",
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = TRUE,
  toolbox.feature.dataZoom.show = TRUE,
  toolbox.feature.magicType.show = TRUE,
  toolbox.feature.magicType.type = c("line", "bar", "stack"),
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
AggMethod

character
PreAgg

logical
XVar

X-Axis variable name
YVar

Y-Axis variable name. You can supply multiple YVars
DualYVar

Secondary Y-Axis variables. Leave NULL for no secondary axis. Only one variable is allowed and when this is set only one YVar is allowed. An error will be thrown if those conditions are not met
GroupVar

One Grouping Variable
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
DualYVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
MouseScroll

logical, zoom via mouse scroll
TimeLine

Logical
ShowSymbol

= FALSE
lineStyle.color

hex or name
lineStyle.width

numeric
lineStyle.type

'solid' 'dashed' 'dotted'
lineStyle.shadowColor

hex or color
lineStyle.shadowBlur

numeric
lineStyle.shadowOffsetX

numeric
lineStyle.shadowOffsetY

numeric
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
xAxis.title

Axis title
xAxis.min

Min value
xAxis.max

Max value
xAxis.position

'bottom', 'top'
xAxis.nameLocation

'center', 'start', 'middle'
xAxis.axisTick.customValues

Custom values for the x-axis
xAxis.nameTextStyle.color

hex or named color
xAxis.nameTextStyle.padding

numeric
xAxis.nameTextStyle.align

'center', 'left', 'right'
xAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
xAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.nameTextStyle.fontSize

numeric
xAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.nameTextStyle.textShadowColor

hex or named color
xAxis.nameTextStyle.textShadowBlur

numeric
xAxis.nameTextStyle.textShadowOffsetX

numeric
xAxis.nameTextStyle.textShadowOffsetY

numeric
xAxis.splitNumber

numeric. Increments for numeric axis labels
xAxis.axisLabel.rotate

numeric
xAxis.axisLabel.margin

numeric
xAxis.axisLabel.color

hex or named
xAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
xAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
xAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
xAxis.axisLabel.fontSize

numeric
xAxis.axisLabel.align

'center', 'left', 'right'
xAxis.axisLabel.verticalAlign

'top', 'bottom'
xAxis.axisLabel.backgroundColor

hex or named
xAxis.axisLabel.borderColor

hex or named
xAxis.axisLabel.borderWidth

numeric
xAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.borderRadius

numeric
xAxis.axisLabel.padding

numeric
xAxis.axisLabel.shadowColor

hex or named
xAxis.axisLabel.shadowBlur

numeric
xAxis.axisLabel.shadowOffsetX

numeric
xAxis.axisLabel.shadowOffsetY

numeric
xAxis.axisLabel.textBorderColor

hex or named
xAxis.axisLabel.textBorderWidth

numeric
xAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
xAxis.axisLabel.textShadowColor

hex or named
xAxis.axisLabel.textShadowBlur

numeric
xAxis.axisLabel.textShadowOffsetX

numeric
xAxis.axisLabel.textShadowOffsetY

numeric
xAxis.axisLabel.overflow

'truncate'
yAxis.title

Axis title
yAxis.min

Min value
yAxis.max

Max value
yAxis.position

'bottom', 'top'
yAxis.nameLocation

'center', 'start', 'middle'
yAxis.axisTick.customValues

Custom values for the y-axis
yAxis.nameTextStyle.color

hex or named color
yAxis.nameTextStyle.padding

numeric
yAxis.nameTextStyle.align

'center', 'left', 'right'
yAxis.nameTextStyle.fontStyle

'italic', 'normal' 'oblique'
yAxis.nameTextStyle.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.nameTextStyle.fontSize

numeric
yAxis.nameTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.nameTextStyle.textShadowColor

hex or named color
yAxis.nameTextStyle.textShadowBlur

numeric
yAxis.nameTextStyle.textShadowOffsetX

numeric
yAxis.nameTextStyle.textShadowOffsetY

numeric
yAxis.splitNumber

numeric. Increments for numeric axis labels
yAxis.axisLabel.rotate

numeric
yAxis.axisLabel.margin

numeric
yAxis.axisLabel.color

hex or named
yAxis.axisLabel.fontStyle

'italic', 'normal' 'oblique'
yAxis.axisLabel.fontWeight

'normal', 'bold', 'bolder', 'lighter'
yAxis.axisLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
yAxis.axisLabel.fontSize

numeric
yAxis.axisLabel.align

'center', 'left', 'right'
yAxis.axisLabel.verticalAlign

'top', 'bottom'
yAxis.axisLabel.backgroundColor

hex or named
yAxis.axisLabel.borderColor

hex or named
yAxis.axisLabel.borderWidth

numeric
yAxis.axisLabel.borderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.borderRadius

numeric
yAxis.axisLabel.padding

numeric
yAxis.axisLabel.shadowColor

hex or named
yAxis.axisLabel.shadowBlur

numeric
yAxis.axisLabel.shadowOffsetX

numeric
yAxis.axisLabel.shadowOffsetY

numeric
yAxis.axisLabel.textBorderColor

hex or named
yAxis.axisLabel.textBorderWidth

numeric
yAxis.axisLabel.textBorderType

'solid', 'dashed', 'dotted'
yAxis.axisLabel.textShadowColor

hex or named
yAxis.axisLabel.textShadowBlur

numeric
yAxis.axisLabel.textShadowOffsetX

numeric
yAxis.axisLabel.textShadowOffsetY

numeric
yAxis.axisLabel.overflow

'truncate'
legend.show

logical
legend.type

'scroll' 'plain'
legend.selector

logical
legend.icon

'circle', 'rect', 'roundRect', 'triangle', 'diamond', 'pin', 'arrow', 'none'
legend.align

'auto' 'left' 'right'
legend.padding

numeric
legend.itemGap

numeric
legend.itemWidth

numeric
legend.orient

'vertical' 'horizontal'
legend.width

numeric
legend.height

numeric
legend.left

numeric
legend.right

numeric
legend.top

numeric
legend.bottom

numeric
legend.backgroundColor

hex or color name
legend.borderColor

hex or color name
legend.borderWidth

numeric
legend.borderRadius

numeric
legend.shadowBlur

numeric
legend.shadowColor

hex or color name
legend.shadowOffsetX

numeric
legend.shadowOffsetY

numeric
legend.itemStyle.color

hex or color name
legend.itemStyle.borderColor

hex or color name
legend.itemStyle.borderWidth

numeric
legend.itemStyle.borderType

'solid' 'dashed' 'dotted'
legend.itemStyle.shadowBlur

numeric
legend.itemStyle.shadowColor

hex or color name
legend.itemStyle.shadowOffsetX

numeric
legend.itemStyle.shadowOffsetY

numeric
legend.itemStyle.opacity

numeric 0 to 1
legend.lineStyle.color

hex or color name
legend.lineStyle.width

numeric
legend.lineStyle.type

'solid' 'dashed' 'dotted'
legend.lineStyle.shadowBlur

numeric
legend.lineStyle.shadowColor

hex or color name
legend.lineStyle.shadowOffsetX

numeric
legend.lineStyle.shadowOffsetY

numeric
legend.lineStyle.opacity

numeric 0 to 1
legend.lineStyle.inactiveColor

hex or color name
legend.lineStyle.inactiveWidth

numeric
legend.textStyle.color

hex or color name
legend.textStyle.fontStyle

'normal' 'italic' 'oblique'
legend.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.textStyle.fontSize

numeric
legend.textStyle.backgroundColor

hex or color name
legend.textStyle.borderColor

hex or color name
legend.textStyle.borderWidth

numeric
legend.textStyle.borderType

'solid' 'dashed' 'dotted'
legend.textStyle.borderRadius

numeric
legend.textStyle.padding

numeric
legend.textStyle.shadowColor

hex or color name
legend.textStyle.shadowBlur

numeric
legend.textStyle.shadowOffsetX

numeric
legend.textStyle.shadowOffsetY

numeric
legend.textStyle.width

numeric
legend.textStyle.height

numeric
legend.textStyle.textBorderColor

hex or color name
legend.textStyle.textBorderWidth

numeric
legend.textStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.textStyle.textShadowColor

hex or color name
legend.textStyle.textShadowBlur

numeric
legend.textStyle.textShadowOffsetX

numeric
legend.textStyle.textShadowOffsetY

numeric
legend.pageTextStyle.color

hex or color name
legend.pageTextStyle.fontStyle

'normal' 'italic' 'oblique'
legend.pageTextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.pageTextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.pageTextStyle.fontSize

numeric
legend.pageTextStyle.lineHeight

numeric
legend.pageTextStyle.width

numeric
legend.pageTextStyle.height

numeric
legend.pageTextStyle.textBorderColor

hex or color name
legend.pageTextStyle.textBorderWidth

numeric
legend.pageTextStyle.textBorderType

'solid' 'dashed' 'dotted'
legend.pageTextStyle.textShadowColor

hex or color name
legend.pageTextStyle.textShadowBlur

numeric
legend.pageTextStyle.textShadowOffsetX

numeric
legend.pageTextStyle.textShadowOffsetY

numeric
legend.emphasis.selectorLabel.show

logical
legend.emphasis.selectorLabel.distance

numeric
legend.emphasis.selectorLabel.rotate

numeric
legend.emphasis.selectorLabel.color

hex or color name
legend.emphasis.selectorLabel.fontStyle

'normal' 'italic' 'oblique'
legend.emphasis.selectorLabel.fontWeight

'normal' 'bold' 'bolder' 'lighter'
legend.emphasis.selectorLabel.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
legend.emphasis.selectorLabel.fontSize

numeric
legend.emphasis.selectorLabel.align

'left' 'center' 'right'
legend.emphasis.selectorLabel.verticalAlign

'top' 'middle' 'bottom'
legend.emphasis.selectorLabel.lineHeight

numeric
legend.emphasis.selectorLabel.backgroundColor

hex or color name
legend.emphasis.selectorLabel.borderColor

hex or color name
legend.emphasis.selectorLabel.borderWidth

numeric
legend.emphasis.selectorLabel.borderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.borderRadius

numeric
legend.emphasis.selectorLabel.padding

numeric
legend.emphasis.selectorLabel.shadowColor

hex or color name
legend.emphasis.selectorLabel.shadowBlur

numeric
legend.emphasis.selectorLabel.shadowOffsetX

numeric
legend.emphasis.selectorLabel.shadowOffsetY

numeric
legend.emphasis.selectorLabel.width

numeric
legend.emphasis.selectorLabel.height

numeric
legend.emphasis.selectorLabel.textBorderColor

hex or color name
legend.emphasis.selectorLabel.textBorderWidth

numeric
legend.emphasis.selectorLabel.textBorderType

'solid' 'dashed' 'dotted'
legend.emphasis.selectorLabel.textShadowColor

hex or color name
legend.emphasis.selectorLabel.textShadowBlur

numeric
legend.emphasis.selectorLabel.textShadowOffsetX

numeric
legend.emphasis.selectorLabel.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

valid family name
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), WordCloud()

Examples

# Create fake data
data <- AutoPlots::FakeDataGenerator(N = 1000)

# Build plot
AutoPlots::Step(
  dt = data,
  PreAgg = TRUE,
  AggMethod = "mean",
  XVar = "DateTime",
  YVar = "Independent_Variable3",
  YVarTrans = "Identity",
  DualYVar = "Independent_Variable6",
  DualYVarTrans = "Identity",
  GroupVar = NULL,
  Theme = "macarons")

Treemap chart

Description

High-level wrapper for building treemap charts with echarts4r from data in wide/tabular form. This function handles optional aggregation, transformation of the value variable, construction of a hierarchical structure from GroupVar, and then delegates all visual options to the extended helpers such as e_treemap_full, e_title_full, e_legend_full, e_tooltip_full, and e_toolbox_full.

Usage

Treemap(
  dt = NULL,
  PreAgg = TRUE,
  YVar = NULL,
  GroupVar = NULL,
  RateNumer = NULL,
  RateDenom = NULL,
  AreaMetric = NULL,
  YVarTrans = "Identity",
  AggMethod = "sum",
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  ShowLabels = TRUE,
  MouseScroll = FALSE,
  squareRatio = NULL,
  leafDepth = 1,
  drillDownIcon = "<U+25B6>",
  roam = NULL,
  scaleLimit.min = NULL,
  scaleLimit.max = NULL,
  nodeClick = "zoomToNode",
  zoomToNodeRatio = 0.32 * 0.32,
  visualDimension = NULL,
  visualMin = NULL,
  visualMax = NULL,
  colorAlpha = NULL,
  colorSaturation = NULL,
  colorMappingBy = "value",
  visibleMin = 10,
  childrenVisibleMin = NULL,
  silent = FALSE,
  animationDuration = 1500,
  animationEasing = "quinticInOut",
  animationDelay = 0,
  tooltip = NULL,
  cursor = "pointer",
  label.show = TRUE,
  label.position = NULL,
  label.distance = NULL,
  label.rotate = NULL,
  label.offset = NULL,
  label.textMargin = NULL,
  label.minMargin = NULL,
  label.formatter = NULL,
  label.color = "black",
  label.fontStyle = NULL,
  label.fontWeight = NULL,
  label.fontFamily = NULL,
  label.fontSize = NULL,
  label.align = NULL,
  label.verticalAlign = NULL,
  label.lineHeight = NULL,
  label.backgroundColor = NULL,
  label.borderColor = NULL,
  label.borderWidth = NULL,
  label.borderType = NULL,
  label.borderDashOffset = NULL,
  label.borderRadius = NULL,
  label.padding = NULL,
  label.shadowColor = NULL,
  label.shadowBlur = NULL,
  label.shadowOffsetX = NULL,
  label.shadowOffsetY = NULL,
  label.width = NULL,
  label.height = NULL,
  label.textBorderColor = NULL,
  label.textBorderWidth = NULL,
  label.textBorderType = NULL,
  label.textBorderDashOffset = NULL,
  label.textShadowColor = NULL,
  label.textShadowBlur = NULL,
  label.textShadowOffsetX = NULL,
  label.textShadowOffsetY = NULL,
  label.overflow = NULL,
  label.ellipsis = NULL,
  label.rich = NULL,
  label.richInheritPlainLabel = NULL,
  upperLabel.show = FALSE,
  upperLabel.position = NULL,
  upperLabel.distance = NULL,
  upperLabel.rotate = NULL,
  upperLabel.offset = NULL,
  upperLabel.formatter = NULL,
  upperLabel.color = NULL,
  upperLabel.fontStyle = NULL,
  upperLabel.fontWeight = NULL,
  upperLabel.fontFamily = NULL,
  upperLabel.fontSize = NULL,
  upperLabel.align = NULL,
  upperLabel.verticalAlign = NULL,
  upperLabel.lineHeight = NULL,
  upperLabel.backgroundColor = NULL,
  upperLabel.borderColor = NULL,
  upperLabel.borderWidth = NULL,
  upperLabel.borderType = NULL,
  upperLabel.borderDashOffset = NULL,
  upperLabel.borderRadius = NULL,
  upperLabel.padding = NULL,
  upperLabel.shadowColor = NULL,
  upperLabel.shadowBlur = NULL,
  upperLabel.shadowOffsetX = NULL,
  upperLabel.shadowOffsetY = NULL,
  upperLabel.width = NULL,
  upperLabel.height = NULL,
  upperLabel.textBorderColor = NULL,
  upperLabel.textBorderWidth = NULL,
  upperLabel.textBorderType = NULL,
  upperLabel.textBorderDashOffset = NULL,
  upperLabel.textShadowColor = NULL,
  upperLabel.textShadowBlur = NULL,
  upperLabel.textShadowOffsetX = NULL,
  upperLabel.textShadowOffsetY = NULL,
  upperLabel.overflow = NULL,
  upperLabel.ellipsis = NULL,
  upperLabel.rich = NULL,
  upperLabel.richInheritPlainLabel = NULL,
  itemStyle.color = NULL,
  itemStyle.borderRadius = 20,
  itemStyle.borderWidth = 2,
  itemStyle.gapWidth = 5,
  itemStyle.borderColor = "black",
  itemStyle.borderColorSaturation = NULL,
  itemStyle.shadowBlur = NULL,
  itemStyle.shadowColor = NULL,
  itemStyle.shadowOffsetX = NULL,
  itemStyle.shadowOffsetY = NULL,
  itemStyle.opacity = NULL,
  itemStyle.decal = NULL,
  emphasis.disabled = FALSE,
  emphasis.focus = NULL,
  emphasis.blurScope = "coordinateSystem",
  emphasis.label = NULL,
  emphasis.labelLine = NULL,
  emphasis.upperLabel = NULL,
  emphasis.itemStyle.color = NULL,
  emphasis.itemStyle.borderColor = "#FFFFFFFF",
  emphasis.itemStyle.borderWidth = 2,
  emphasis.itemStyle.shadowBlur = 25,
  emphasis.itemStyle.shadowColor = "#FFFFFF77",
  emphasis.itemStyle.shadowOffsetX = 0,
  emphasis.itemStyle.shadowOffsetY = 0,
  emphasis.itemStyle.opacity = 1,
  blur.label = NULL,
  blur.labelLine = NULL,
  blur.upperLabel = NULL,
  blur.itemStyle.color = NULL,
  blur.itemStyle.borderColor = NULL,
  blur.itemStyle.borderWidth = NULL,
  blur.itemStyle.shadowBlur = NULL,
  blur.itemStyle.shadowColor = NULL,
  blur.itemStyle.shadowOffsetX = NULL,
  blur.itemStyle.shadowOffsetY = NULL,
  blur.itemStyle.opacity = 0.35,
  breadcrumb.show = TRUE,
  breadcrumb.left = NULL,
  breadcrumb.top = NULL,
  breadcrumb.right = NULL,
  breadcrumb.bottom = NULL,
  breadcrumb.height = 22,
  breadcrumb.emptyItemWidth = 20,
  breadcrumb.itemStyle.color = "#FFFFFF0F",
  breadcrumb.itemStyle.borderColor = "#FFFFFF22",
  breadcrumb.itemStyle.borderWidth = 1,
  breadcrumb.itemStyle.borderRadius = 3,
  breadcrumb.itemStyle.shadowBlur = 7,
  breadcrumb.itemStyle.shadowColor = "darkblue",
  breadcrumb.itemStyle.shadowOffsetX = 3,
  breadcrumb.itemStyle.shadowOffsetY = 4,
  breadcrumb.itemStyle.textStyle.color = "#FFFFFFCC",
  breadcrumb.itemStyle.textStyle.fontSize = 12,
  breadcrumb.itemStyle.textStyle.fontFamily = "Segoe UI",
  breadcrumb.emphasis.borderColor = "#FFFFFF55",
  breadcrumb.emphasis.borderWidth = 1,
  breadcrumb.emphasis.shadowBlur = NULL,
  breadcrumb.emphasis.shadowColor = NULL,
  breadcrumb.emphasis.shadowOffsetX = NULL,
  breadcrumb.emphasis.shadowOffsetY = NULL,
  breadcrumb.emphasis.textStyle.color = "#FFFFFFAF",
  breadcrumb.emphasis.textStyle.fontSize = 12,
  breadcrumb.emphasis.textStyle.fontFamily = "Segoe UI",
  title.text = NULL,
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  tooltip.show = TRUE,
  tooltip.trigger = "item",
  tooltip.backgroundColor = NULL,
  tooltip.borderColor = NULL,
  tooltip.borderWidth = NULL,
  tooltip.padding = NULL,
  tooltip.axisPointer.type = NULL,
  tooltip.axisPointer.lineStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.color = NULL,
  tooltip.axisPointer.shadowStyle.shadowBlur = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetX = NULL,
  tooltip.axisPointer.shadowStyle.shadowOffsetY = NULL,
  tooltip.axisPointer.shadowStyle.opacity = NULL,
  tooltip.textStyle.color = NULL,
  tooltip.textStyle.fontStyle = NULL,
  tooltip.textStyle.fontWeight = NULL,
  tooltip.textStyle.fontFamily = "Segoe UI",
  tooltip.textStyle.lineHeight = NULL,
  tooltip.textStyle.width = NULL,
  tooltip.textStyle.height = NULL,
  tooltip.textStyle.textBorderColor = NULL,
  tooltip.textStyle.textBorderWidth = NULL,
  tooltip.textStyle.textBorderType = NULL,
  tooltip.textStyle.textShadowColor = NULL,
  tooltip.textStyle.textShadowBlur = NULL,
  tooltip.textStyle.textShadowOffsetX = NULL,
  tooltip.textStyle.textShadowOffsetY = NULL,
  toolbox.show = TRUE,
  toolbox.orient = "horizontal",
  toolbox.itemSize = 15,
  toolbox.itemGap = 8,
  toolbox.top = NULL,
  toolbox.left = NULL,
  toolbox.right = NULL,
  toolbox.bottom = NULL,
  toolbox.width = NULL,
  toolbox.heigth = NULL,
  toolbox.feature.saveAsImage.show = TRUE,
  toolbox.feature.restore.show = FALSE,
  toolbox.feature.dataZoom.show = FALSE,
  toolbox.feature.magicType.show = FALSE,
  toolbox.feature.magicType.type = NULL,
  toolbox.feature.dataView.show = TRUE,
  toolbox.iconStyle.color = NULL,
  toolbox.iconStyle.borderColor = NULL,
  toolbox.emphasis.iconStyle.borderColor = NULL,
  toolbox.iconStyle.shadowBlur = NULL,
  toolbox.iconStyle.shadowColor = NULL,
  toolbox.iconStyle.shadowOffsetX = NULL,
  toolbox.iconStyle.shadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

A data.table or data.frame containing the data to plot. If not already a data.table, it will be coerced internally.
PreAgg

Logical; if FALSE, the function aggregates YVar over GroupVar using AggMethod. If TRUE, the input dt is assumed to already be aggregated at the desired level.
YVar

Character scalar; name of the column in dt that provides the numeric values used for treemap tile sizes.
GroupVar

Character vector; names of one or more columns in dt that define the grouping hierarchy. The first element is treated as the top-level group, the last element as the leaf level.
RateNumer

numerator columns for rolling up rates
RateDenom

denominator columns for rolling up rates
AreaMetric

choice metric for area determination c("main", "rate", "numerator", "denominator")
YVarTrans

Character scalar specifying an optional transformation to apply to YVar after aggregation (e.g. "Identity", "Log", etc.), passed through to AutoTransformationCreate().
AggMethod

Character scalar specifying the aggregation function used when PreAgg = FALSE, e.g. "sum", "mean", etc. This is resolved via SummaryFunction().
Height, Width

Optional numeric or character dimensions passed to echarts4r::e_charts_() as chart size (e.g. 400 or
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
ShowLabels

Logical, currently used as a convenience flag for whether node labels should be visible. This typically maps to label.show and/or upperLabel.show.
MouseScroll

Logical; if TRUE, mouse wheel scrolling can be used for zooming/panning. This typically influences roam or related options.
squareRatio

Numeric squarify aspect ratio for the treemap layout.
leafDepth

Integer maximum depth of nodes to display; when NULL, a default based on length(GroupVar) may be used.
drillDownIcon

Character string for the drill-down icon.
roam

Logical or character; controls whether panning/zooming is enabled for the treemap.
scaleLimit.min, scaleLimit.max

Optional numeric minimum/maximum zoom scale for the treemap.
nodeClick

Character specifying the behaviour when a node is clicked, e.g. "zoomToNode" or "link".
zoomToNodeRatio

Numeric zoom ratio when using nodeClick = "zoomToNode".
visualDimension

Integer or character specifying which dimension is used for visual mapping.
visualMin, visualMax

Numeric visual mapping range for the selected visualDimension.
colorAlpha

Optional numeric range for alpha channel mapping.
colorSaturation

Optional numeric range for color saturation mapping.
colorMappingBy

Character specifying how colors are mapped ("index", "value", etc.).
visibleMin

Numeric threshold that hides nodes whose area is smaller than this value.
childrenVisibleMin

Numeric threshold that hides children nodes whose area is smaller than this value.
silent

Logical indicating whether mouse events are disabled for the treemap series.
animationDuration

Numeric animation duration in milliseconds.
animationEasing

Character name of the easing function used for the treemap animation.
animationDelay

Numeric delay (in milliseconds) before animation starts.
tooltip

Optional list of series-level tooltip options. If NULL, a default formatter is constructed internally.
cursor

Character CSS cursor to use when hovering over nodes.
label.show

Logical; whether node labels are shown (ECharts label.show).
label.position

Character; position of the label relative to the node. Common values: "top", "left", "right", "bottom", "inside", "insideLeft", "insideRight", etc.
label.distance

Numeric or integer; distance to the element when label is outside the node (ECharts label.distance).
label.rotate

Numeric or character; rotation of label text in degrees or "radial", "tangential" depending on context.
label.offset

Numeric/integer vector or list; x/y offset of label from its default position (ECharts label.offset).
label.textMargin

Numeric/integer; extra margin around label text box.
label.minMargin

Numeric/integer; minimum margin between label and node edge.
label.formatter

Character or list; text formatter for labels (string template or JS function).
label.color

Character; text color of labels.
label.fontStyle

Character; label font style. Common values: "normal", "italic", "oblique".
label.fontWeight

Character or numeric; label font weight. E.g. "normal", "bold", "bolder", "lighter", or numeric weights like 400, 700.
label.fontFamily

Character; label font family name.
label.fontSize

Numeric/integer; label font size (px).
label.align

Character; horizontal alignment of label text. One of "left", "center", "right".
label.verticalAlign

Character; vertical alignment of label text. One of "top", "middle", "bottom".
label.lineHeight

Numeric/integer; line height of label text.
label.backgroundColor

Character or list; background color for label (or style object).
label.borderColor

Character; label border color.
label.borderWidth

Numeric/integer; label border width (px).
label.borderType

Character or numeric; border type for label. E.g. "solid", "dashed", "dotted" or numeric pattern.
label.borderDashOffset

Numeric; dash offset for dashed label border.
label.borderRadius

Numeric/integer or vector; corner radius for label background.
label.padding

Numeric/integer or vector; padding inside label box.
label.shadowColor

Character; shadow color of label box.
label.shadowBlur

Numeric/integer; shadow blur radius for label.
label.shadowOffsetX

Numeric/integer; horizontal shadow offset.
label.shadowOffsetY

Numeric/integer; vertical shadow offset.
label.width

Numeric/integer or character; forced label width.
label.height

Numeric/integer or character; forced label height.
label.textBorderColor

Character; color of text stroke (outline).
label.textBorderWidth

Numeric/integer; width of text stroke.
label.textBorderType

Character or numeric; border type of text stroke ("solid", "dashed", etc.).
label.textBorderDashOffset

Numeric; dash offset for text stroke.
label.textShadowColor

Character; color of text shadow.
label.textShadowBlur

Numeric/integer; blur radius of text shadow.
label.textShadowOffsetX

Numeric/integer; horizontal text shadow offset.
label.textShadowOffsetY

Numeric/integer; vertical text shadow offset.
label.overflow

Character; how to handle text overflow. Common values: "truncate", "break", "breakAll".
label.ellipsis

Character; string used as ellipsis when truncating text.
label.rich

List; rich text styles object for label rich text.
label.richInheritPlainLabel

Logical; whether rich text inherits plain label styles.
upperLabel.show

Logical; whether upper-level labels are shown (ECharts upperLabel.show).
upperLabel.position

Character; position of the upper-level label. Same options as label.position.
upperLabel.distance

Numeric/integer; distance to element when upper label is outside the node.
upperLabel.rotate

Numeric or character; rotation of upper-level label.
upperLabel.offset

Numeric/integer vector or list; offset for upper-level label position.
upperLabel.formatter

Character or list; formatter for upper-level labels (string template or JS function).
upperLabel.color

Character; text color of upper-level labels.
upperLabel.fontStyle

Character; font style for upper-level labels ("normal", "italic", etc.).
upperLabel.fontWeight

Character or numeric; font weight for upper-level labels.
upperLabel.fontFamily

Character; font family for upper-level labels.
upperLabel.fontSize

Numeric/integer; font size for upper-level labels.
upperLabel.align

Character; horizontal alignment of upper-level text.
upperLabel.verticalAlign

Character; vertical alignment of upper-level text.
upperLabel.lineHeight

Numeric/integer; line height of upper-level text.
upperLabel.backgroundColor

Character or list; background color for upper-level label box.
upperLabel.borderColor

Character; border color for upper-level label.
upperLabel.borderWidth

Numeric/integer; border width for upper-level label.
upperLabel.borderType

Character or numeric; border type for upper-level label.
upperLabel.borderDashOffset

Numeric; dash offset for upper-level label border.
upperLabel.borderRadius

Numeric/integer or vector; border radius for upper-level label box.
upperLabel.padding

Numeric/integer or vector; padding for upper-level label box.
upperLabel.shadowColor

Character; shadow color for upper-level label.
upperLabel.shadowBlur

Numeric/integer; shadow blur for upper-level label.
upperLabel.shadowOffsetX

Numeric/integer; horizontal shadow offset for upper-level label.
upperLabel.shadowOffsetY

Numeric/integer; vertical shadow offset for upper-level label.
upperLabel.width

Numeric/integer or character; forced width for upper-level label.
upperLabel.height

Numeric/integer or character; forced height for upper-level label.
upperLabel.textBorderColor

Character; text stroke color for upper-level label.
upperLabel.textBorderWidth

Numeric/integer; text stroke width for upper-level label.
upperLabel.textBorderType

Character or numeric; text stroke type for upper-level label.
upperLabel.textBorderDashOffset

Numeric; dash offset for upper-level text stroke.
upperLabel.textShadowColor

Character; text shadow color for upper-level label.
upperLabel.textShadowBlur

Numeric/integer; text shadow blur for upper-level label.
upperLabel.textShadowOffsetX

Numeric/integer; horizontal text shadow offset for upper-level label.
upperLabel.textShadowOffsetY

Numeric/integer; vertical text shadow offset for upper-level label.
upperLabel.overflow

Character; overflow behaviour for upper-level text ("truncate", "break", etc.).
upperLabel.ellipsis

Character; ellipsis string for upper-level text.
upperLabel.rich

List; rich text styles object for upper-level labels.
upperLabel.richInheritPlainLabel

Logical; whether rich text styles for upper-level labels inherit plain label styles.
itemStyle.color

Character or list; node color or style object for itemStyle.color.
itemStyle.borderRadius

Numeric/integer or vector; border radius for node rectangles.
itemStyle.borderWidth

Numeric/integer; border width of node rectangles.
itemStyle.gapWidth

Numeric/integer; gap width between nodes.
itemStyle.borderColor

Character; border color of node rectangles.
itemStyle.borderColorSaturation

Numeric; saturation adjustment of border color when colorSaturation is used.
itemStyle.shadowBlur

Numeric/integer; blur radius for node shadow.
itemStyle.shadowColor

Character; shadow color for nodes.
itemStyle.shadowOffsetX

Numeric/integer; horizontal node shadow offset.
itemStyle.shadowOffsetY

Numeric/integer; vertical node shadow offset.
itemStyle.opacity

Numeric in [0, 1]; opacity of nodes.
itemStyle.decal

List; decal pattern options for nodes.
emphasis.disabled

Logical; whether emphasis (hover) is disabled for this series.
emphasis.focus

Character; focus mode when hovering. Typical values: "none", "self", "ancestor", "descendant".
emphasis.blurScope

Character; blur scope of non-focused elements. Common values: "coordinateSystem", "series", "global".
emphasis.label

List; label options applied in emphasis state (overrides label when hovered).
emphasis.labelLine

List; label line options in emphasis state.
emphasis.upperLabel

List; upper-level label options in emphasis state.
emphasis.itemStyle.color

Character or NULL; fill color for treemap nodes in the emphasis (hover) state. Maps to emphasis.itemStyle.color.
emphasis.itemStyle.borderColor

Character or NULL; border color for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.borderColor.
emphasis.itemStyle.borderWidth

Numeric or NULL; border width (in pixels) for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.borderWidth.
emphasis.itemStyle.shadowBlur

Numeric or NULL; blur radius for the drop shadow of treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowBlur.
emphasis.itemStyle.shadowColor

Character or NULL; shadow color for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowColor.
emphasis.itemStyle.shadowOffsetX

Numeric or NULL; horizontal offset (in pixels) of the shadow for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowOffsetX.
emphasis.itemStyle.shadowOffsetY

Numeric or NULL; vertical offset (in pixels) of the shadow for treemap nodes in the emphasis state. Maps to emphasis.itemStyle.shadowOffsetY.
emphasis.itemStyle.opacity

Numeric or NULL; opacity of treemap nodes in the emphasis state, typically a value in [0, 1]. Maps to emphasis.itemStyle.opacity.
blur.label

List; label options in blur state (when other items are focused).
blur.labelLine

List; label line options in blur state.
blur.upperLabel

List; upper-level label options in blur state.
blur.itemStyle.color

Character or NULL; fill color for treemap nodes in the blur (de-emphasized) state when other nodes are highlighted. Maps to blur.itemStyle.color.
blur.itemStyle.borderColor

Character or NULL; border color for treemap nodes in the blur state. Maps to blur.itemStyle.borderColor.
blur.itemStyle.borderWidth

Numeric or NULL; border width (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.borderWidth.
blur.itemStyle.shadowBlur

Numeric or NULL; blur radius for the drop shadow of treemap nodes in the blur state. Maps to blur.itemStyle.shadowBlur.
blur.itemStyle.shadowColor

Character or NULL; shadow color for treemap nodes in the blur state. Maps to blur.itemStyle.shadowColor.
blur.itemStyle.shadowOffsetX

Numeric or NULL; horizontal shadow offset (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.shadowOffsetX.
blur.itemStyle.shadowOffsetY

Numeric or NULL; vertical shadow offset (in pixels) for treemap nodes in the blur state. Maps to blur.itemStyle.shadowOffsetY.
blur.itemStyle.opacity

Numeric or NULL; opacity of treemap nodes in the blur state, typically a value in [0, 1]. Maps to blur.itemStyle.opacity.
breadcrumb.show

Logical; whether to display the treemap breadcrumb navigation bar.
breadcrumb.left

Position of the breadcrumb container from the left; numeric (px) or character e.g. "center"
breadcrumb.top

Position of the breadcrumb container from the top; numeric (px) or character.
breadcrumb.right

Position of the breadcrumb container from the right; numeric (px) or character.
breadcrumb.bottom

Position of the breadcrumb container from the bottom; numeric (px) or character.
breadcrumb.height

Height of the breadcrumb bar.
breadcrumb.emptyItemWidth

Width of a breadcrumb node when it has no name (placeholder width).
breadcrumb.itemStyle.color

Background color of breadcrumb nodes.
breadcrumb.itemStyle.borderColor

Border color for breadcrumb nodes.
breadcrumb.itemStyle.borderWidth

Border width for breadcrumb nodes.
breadcrumb.itemStyle.borderRadius

Corner radius for breadcrumb nodes.
breadcrumb.itemStyle.shadowBlur

Shadow blur radius for breadcrumb nodes.
breadcrumb.itemStyle.shadowColor

Shadow color for breadcrumb nodes.
breadcrumb.itemStyle.shadowOffsetX

Horizontal shadow offset (in px) for breadcrumb nodes.
breadcrumb.itemStyle.shadowOffsetY

Vertical shadow offset (in px) for breadcrumb nodes.
breadcrumb.itemStyle.textStyle.color

Text color for breadcrumb labels.
breadcrumb.itemStyle.textStyle.fontSize

Font size for breadcrumb labels.
breadcrumb.itemStyle.textStyle.fontFamily

Font family for breadcrumb labels.
breadcrumb.emphasis.borderColor

Border color when a breadcrumb node is emphasized (hover/active).
breadcrumb.emphasis.borderWidth

Border width when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowBlur

Shadow blur radius when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowColor

Shadow color when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowOffsetX

Horizontal shadow offset (in px) when a breadcrumb node is emphasized.
breadcrumb.emphasis.shadowOffsetY

Vertical shadow offset (in px) when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.color

Text color when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.fontSize

Font size when a breadcrumb node is emphasized.
breadcrumb.emphasis.textStyle.fontFamily

Font family when a breadcrumb node is emphasized.
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
tooltip.show

logical
tooltip.trigger

"cross" "axis" "item" "none"
tooltip.backgroundColor

hex or name
tooltip.borderColor

numeric
tooltip.borderWidth

numeric
tooltip.padding

numeric
tooltip.axisPointer.type

"line" or "shadow"
tooltip.axisPointer.lineStyle.color

hex or name
tooltip.axisPointer.shadowStyle.color

hex or name
tooltip.axisPointer.shadowStyle.shadowBlur

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetX

numeric
tooltip.axisPointer.shadowStyle.shadowOffsetY

numeric
tooltip.axisPointer.shadowStyle.opacity

numeric between 0 and 1
tooltip.textStyle.color

hex or name
tooltip.textStyle.fontStyle

"normal" "italic" "oblique"
tooltip.textStyle.fontWeight

"normal" "bold" "bolder" "lighter"
tooltip.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
tooltip.textStyle.lineHeight

numeric
tooltip.textStyle.width

numeric
tooltip.textStyle.height

numeric
tooltip.textStyle.textBorderColor

hex or name
tooltip.textStyle.textBorderWidth

numeric
tooltip.textStyle.textBorderType

"solid" "dashed" "dotted"
tooltip.textStyle.textShadowColor

hex or name
tooltip.textStyle.textShadowBlur

numeric
tooltip.textStyle.textShadowOffsetX

numeric
tooltip.textStyle.textShadowOffsetY

numeric
toolbox.show

logical
toolbox.orient

"horizontal" or "vertical"
toolbox.itemSize

Default 15
toolbox.itemGap

Default 8
toolbox.top

numeric
toolbox.left

numeric
toolbox.right

numeric
toolbox.bottom

numeric
toolbox.width

numeric
toolbox.heigth

numeric
toolbox.feature.saveAsImage.show

logical
toolbox.feature.restore.show

logical
toolbox.feature.dataZoom.show

logical
toolbox.feature.magicType.show

logical
toolbox.feature.magicType.type

'bar' 'line' 'stack'
toolbox.feature.dataView.show

logical
toolbox.iconStyle.color

hex
toolbox.iconStyle.borderColor

hex
toolbox.emphasis.iconStyle.borderColor

hex
toolbox.iconStyle.shadowBlur

numeric
toolbox.iconStyle.shadowColor

hex
toolbox.iconStyle.shadowOffsetX

numeric
toolbox.iconStyle.shadowOffsetY

numeric
Debug

Logical; if TRUE, additional diagnostic information may be printed or returned for debugging purposes.

Details

The treemap hierarchy is driven by GroupVar: when multiple grouping variables are supplied, they are treated as ordered levels from the top of the hierarchy down to the leaves, and YVar is used as the size measure for the tiles.

Value

An echarts4r object representing a treemap chart.

Examples

## Not run: 
library(data.table)
library(AutoPlots)

dt <- data.table(
  region = rep(c("North", "South"), each = 4),
  category = rep(c("A", "B"), times = 4),
  value = c(10, 20, 15, 5, 8, 12, 18, 7)
)

Treemap(
  dt       = dt,
  PreAgg   = FALSE,
  YVar     = "value",
  GroupVar = c("region", "category"),
  Theme    = "dark",
  title.text = "Example treemap"
)

## End(Not run)

VariableImportance

Description

Generate variable importance plots

Usage

VariableImportance(
  dt = NULL,
  XVar = NULL,
  YVar = NULL,
  GroupVar = NULL,
  YVarTrans = "Identity",
  XVarTrans = "Identity",
  FacetRows = 1,
  FacetCols = 1,
  FacetLevels = NULL,
  AggMethod = "mean",
  Height = NULL,
  Width = NULL,
  ShowLabels = FALSE,
  Theme = "dark",
  TimeLine = FALSE,
  title.text = "Variable Importance",
  yAxis.title = "",
  xAxis.title = "",
  Debug = FALSE
)

Arguments

dt

source data.table
XVar

Column name of X-Axis variable. If NULL then ignored
YVar

Column name of Y-Axis variable. If NULL then ignored
GroupVar

Column name of Group Variable for distinct colored histograms by group levels
YVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
XVarTrans

"Asinh", "Log", "LogPlus1", "Sqrt", "Asin", "Logit", "PercRank", "Standardize", "BoxCox", "YeoJohnson"
FacetRows

Defaults to 1 which causes no faceting to occur vertically. Otherwise, supply a numeric value for the number of output grid rows
FacetCols

Defaults to 1 which causes no faceting to occur horizontally. Otherwise, supply a numeric value for the number of output grid columns
FacetLevels

Faceting rows x columns is the max number of levels allowed in a grid. If your GroupVar has more you can supply the levels to display.
AggMethod

Choose from 'mean', 'sum', 'sd', and 'median'
Height

"400px"
Width

"200px"
ShowLabels

character
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
TimeLine

logical
Debug

Debugging purposes

Value

plot

Author(s)

Adrian Antico

See Also

Other Model Evaluation: BinaryMetricsPlot(), Calibration.Box(), Calibration.Line(), ConfusionMatrix(), Gains(), ImportancePareto(), Lift(), PartialDependence.Box(), PartialDependence.HeatMap(), PartialDependence.Line(), Plot.BinaryMetrics(), Plot.Calibration.Box(), Plot.Calibration.Line(), Plot.ConfusionMatrix(), Plot.Gains(), Plot.Lift(), Plot.PartialDependence.Box(), Plot.PartialDependence.HeatMap(), Plot.PartialDependence.Line(), Plot.ROC(), Plot.Residuals.Histogram(), Plot.Residuals.Scatter(), Plot.ShapImportance(), Plot.VariableImportance(), Plot.prROC(), ROC(), Residuals.Histogram(), Residuals.Scatter(), ShapImportance()

WordCloud

Description

WordCloud plots

Usage

WordCloud(
  dt = NULL,
  YVar = NULL,
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  title.text = "Word Cloud",
  title.subtext = NULL,
  title.link = NULL,
  title.sublink = NULL,
  title.Align = "left",
  title.top = NULL,
  title.left = "left",
  title.right = NULL,
  title.bottom = NULL,
  title.padding = NULL,
  title.itemGap = NULL,
  title.backgroundColor = NULL,
  title.borderColor = NULL,
  title.borderWidth = NULL,
  title.borderRadius = NULL,
  title.shadowColor = NULL,
  title.shadowBlur = NULL,
  title.shadowOffsetX = NULL,
  title.shadowOffsetY = NULL,
  title.textStyle.color = NULL,
  title.textStyle.fontStyle = NULL,
  title.textStyle.fontWeight = NULL,
  title.textStyle.fontFamily = "Segoe UI",
  title.textStyle.fontSize = NULL,
  title.textStyle.lineHeight = NULL,
  title.textStyle.width = NULL,
  title.textStyle.height = NULL,
  title.textStyle.textBorderColor = NULL,
  title.textStyle.textBorderWidth = NULL,
  title.textStyle.textBorderType = NULL,
  title.textStyle.textBorderDashOffset = NULL,
  title.textStyle.textShadowColor = NULL,
  title.textStyle.textShadowBlur = NULL,
  title.textStyle.textShadowOffsetX = NULL,
  title.textStyle.textShadowOffsetY = NULL,
  title.subtextStyle.color = NULL,
  title.subtextStyle.align = NULL,
  title.subtextStyle.fontStyle = NULL,
  title.subtextStyle.fontWeight = NULL,
  title.subtextStyle.fontFamily = "Segoe UI",
  title.subtextStyle.fontSize = NULL,
  title.subtextStyle.lineHeight = NULL,
  title.subtextStyle.width = NULL,
  title.subtextStyle.height = NULL,
  title.subtextStyle.textBorderColor = NULL,
  title.subtextStyle.textBorderWidth = NULL,
  title.subtextStyle.textBorderType = NULL,
  title.subtextStyle.textBorderDashOffset = NULL,
  title.subtextStyle.textShadowColor = NULL,
  title.subtextStyle.textShadowBlur = NULL,
  title.subtextStyle.textShadowOffsetX = NULL,
  title.subtextStyle.textShadowOffsetY = NULL,
  Debug = FALSE
)

Arguments

dt

source data.table
YVar

Y-Axis variable name
Height

"400px"
Width

"200px"
Theme

"auritus", "azul", "bee-inspired", "blue", "caravan", "carp", "chalk", "cool", "dark", "dark-blue", "dark-bold", "dark-digerati", "dark-fresh-cut", "dark-mushroom", "eduardo", "essos", "forest", "fresh-cut", "fruit", "gray", "green", "halloween", "helianthus", "infographic", "inspired", "jazz", "london", "macarons", "macarons2", "mint", "purple-passion", "rainbow", "red", "red-velvet", "roma", "royal", "sakura", "shine", "tech-blue", "v5", "vintage", "walden", "wef", "weforum", "westeros", "wonderland"
title.text

Title name
title.subtext

Subtitle name
title.link

Title as a link
title.sublink

Subtitle as a link
title.Align

'auto' 'left' 'right' 'center'
title.top

'auto' '20' 'top' 'middle' 'bottom'
title.left

distance between title and left side of container
title.right

distance between title and right side of container
title.bottom

'auto' '20' 'top' 'middle' 'bottom'
title.padding

numeric
title.itemGap

space between title and subtitle
title.backgroundColor

hex or name
title.borderColor

hex or name
title.borderWidth

numeric
title.borderRadius

numeric
title.shadowColor

hex or name
title.shadowBlur

numeric
title.shadowOffsetX

numeric
title.shadowOffsetY

numeric
title.textStyle.color

hex or name
title.textStyle.fontStyle

'normal' 'italic' 'oblique'
title.textStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.textStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.textStyle.fontSize

numeric
title.textStyle.lineHeight

numeric
title.textStyle.width

numeric
title.textStyle.height

numeric
title.textStyle.textBorderColor

hex or name
title.textStyle.textBorderWidth

numeric
title.textStyle.textBorderType

'solid' 'dashed' 'dotted'
title.textStyle.textBorderDashOffset

numeric
title.textStyle.textShadowColor

hex or name
title.textStyle.textShadowBlur

numeric
title.textStyle.textShadowOffsetX

numeric
title.textStyle.textShadowOffsetY

numeric
title.subtextStyle.color

hex or name
title.subtextStyle.align

'auto' 'left' 'right' 'center'
title.subtextStyle.fontStyle

'normal' 'italic' 'oblique'
title.subtextStyle.fontWeight

'normal' 'bold' 'bolder' 'lighter'
title.subtextStyle.fontFamily

'sans-serif', 'serif', 'monospace', 'Arial', 'Times New Roman', 'Roboto', 'Open Sans', 'Lato', 'Helvetica', 'Georgia', 'Verdana', 'Arial', 'Tahoma', 'Courier New'
title.subtextStyle.fontSize

numeric
title.subtextStyle.lineHeight

numeric
title.subtextStyle.width

numeric
title.subtextStyle.height

numeric
title.subtextStyle.textBorderColor

hex or name
title.subtextStyle.textBorderWidth

numeric
title.subtextStyle.textBorderType

'solid' 'dashed' 'dotted'
title.subtextStyle.textBorderDashOffset

numeric
title.subtextStyle.textShadowColor

numeric
title.subtextStyle.textShadowBlur

numeric
title.subtextStyle.textShadowOffsetX

numeric
title.subtextStyle.textShadowOffsetY

numeric
Debug

Debugging purposes

Value

plot

See Also

Other Standard Plots: ACF(), Area(), Bar(), BarPlot3D(), Box(), Copula(), Copula3D(), CorrMatrix(), Density(), Donut(), HeatMap(), Histogram(), Line(), PACF(), Parallel(), Pie(), Plot.ACF(), Plot.Area(), Plot.Bar(), Plot.BarPlot3D(), Plot.Box(), Plot.Copula(), Plot.Copula3D(), Plot.CorrMatrix(), Plot.Density(), Plot.Donut(), Plot.HeatMap(), Plot.Histogram(), Plot.Line(), Plot.PACF(), Plot.Parallel(), Plot.Pie(), Plot.ProbabilityPlot(), Plot.Radar(), Plot.River(), Plot.Rosetype(), Plot.Scatter(), Plot.Scatter3D(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud(), ProbabilityPlot(), Radar(), River(), Rosetype(), Scatter(), Scatter3D(), StackedBar(), Step()

Examples

# Create fake data
dt <- FakeDataGenerator(AddComment = TRUE)

# Create plot
AutoPlots::WordCloud(
  dt = dt,
  YVar = "Comment",
  Height = NULL,
  Width = NULL,
  Theme = "dark",
  Debug = FALSE)