AutoPlots (version 1.0.0)

Plot.Box: 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
)

Value

plot

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

Author

Adrian Antico

See Also

Other Standard Plots: Plot.ACF(), Plot.Area(), Plot.BarPlot3D(), Plot.Bar(), Plot.Copula3D(), 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.Scatter3D(), Plot.Scatter(), Plot.StackedBar(), Plot.Step(), Plot.WordCloud()

Examples

# Create fake data
dt <- data.table::data.table(Y = qnorm(p = 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)