Create a HTML widget displaying a boxplot chart.
amBoxplotChart(
data,
category,
value,
color = NULL,
hline = NULL,
yLimits = NULL,
expandY = 5,
valueFormatter = "#.",
chartTitle = NULL,
theme = NULL,
animated = TRUE,
tooltip = TRUE,
bullets = NULL,
backgroundColor = NULL,
xAxis = NULL,
yAxis = NULL,
scrollbarX = FALSE,
scrollbarY = FALSE,
caption = NULL,
image = NULL,
cursor = FALSE,
width = NULL,
height = NULL,
export = FALSE,
chartId = NULL,
elementId = NULL
)
a dataframe
name of the column of data
to be used for the
category axis; this can be a date column
name of the column of data
to be used for the
value axis
the color of the boxplots; it can be given by the name of a R
color, the name of a CSS color, e.g. "crimson"
or "fuchsia"
,
a HEX code like "#FF009A"
, a RGB code like
"rgb(255,100,39)"
, or a HSL code like "hsl(360,11,255)"
an optional horizontal line to add to the chart; it must be a
named list of the form list(value = h, line = settings)
where
h
is the "intercept" and settings
is a list of settings
created with amLine
range of the y-axis, a vector of two values specifying
the lower and the upper limits of the y-axis; NULL
for default values
if yLimits = NULL
, a percentage of the range of the
y-axis used to expand this range
a
number formatting string;
it is used to format the values displayed in the cursor tooltips,
the labels of the y-axis unless you specify
your own formatter in the labels
field of the list passed on to
the yAxis
option, and the values displayed in the tooltips unless
you specify your own tooltip text (see the first example of
amBarChart
for the way to set
a number formatter in the tooltip text)
chart title, it can be NULL
or FALSE
for no
title, a character string,
a list of settings created with amText
, or a list with two
fields: text
, a list of settings created with amText
,
and align
, can be "left"
, "right"
or "center"
theme, NULL
or one of "dataviz"
,
"material"
, "kelly"
, "dark"
, "moonrisekingdom"
,
"frozen"
, "spiritedaway"
, "patterns"
,
"microchart"
Boolean, whether to animate the rendering of the graphic
TRUE
for the default tooltips,
FALSE
for no tooltip, otherwise a string for the text to
display in the tooltip
settings of the bullets representing the outliers;
NULL
for default, otherwise a list created with
amCircle
, amTriangle
or
amRectangle
a color for the chart background; it can be
given by the name of a R color, the name of a CSS color, e.g.
"lime"
or "olive"
, an HEX code like
"#ff009a"
, a RGB code like "rgb(255,100,39)"
, or a HSL code
like "hsl(360,11,255)"
settings of the category axis given as a list, or just a string
for the axis title; the list of settings has four possible fields:
a field title
, a list of settings for the axis title created
with amText
,
a field labels
, a list of settings for the axis labels created
with amAxisLabels
,
a field adjust
, a number defining the vertical adjustment of
the axis (in pixels), and
a field gridLines
, a list of settings for
the grid lines created with amLine
settings of the value axis given as a list, or just a string
for the axis title; the list of settings has five possible fields:
a field title
, a list of settings for the axis title created
with amText
,
a field labels
, a list of settings for the axis labels created
with amAxisLabels
,
a field adjust
, a number defining the horizontal adjustment of
the axis (in pixels),
a field gridLines
, a list of settings for
the grid lines created with amLine
and
a field breaks
to control the axis breaks, an R object created with
amAxisBreaks
logical, whether to add a scrollbar for the category axis
logical, whether to add a scrollbar for the value axis
NULL
or FALSE
for no caption, a formatted
text created with amText
, or a list with two fields:
text
, a list created with amText
, and align
,
can be "left"
, "right"
or "center"
option to include an image at a corner of the chart;
NULL
or FALSE
for no image, otherwise a named list with four
possible fields: the field image
(required) is a list created with
amImage
,
the field position
can be "topleft"
, "topright"
,
"bottomleft"
or "bottomright"
, the field hjust
defines the horizontal adjustment, and the field vjust
defines
the vertical adjustment
option to add a cursor on the chart; FALSE
for no
cursor, TRUE
for a cursor with default settings for the tooltips,
or a list of settings created with amTooltip
to
set the style of the tooltips, or a list with three possible fields:
a field tooltip
, a list of tooltip settings created with
amTooltip
, a field
extraTooltipPrecision
, an integer, the number of additional
decimals to display in the tooltips, and a field modifier
,
which defines a modifier for the
values displayed in the tooltips; a modifier is some JavaScript code
given as a string, which performs a modification of a string named
text
, e.g. modifier = "text = '>>>' + text;"
the width of the chart, e.g. "600px"
or "80%"
;
ignored if the chart is displayed in Shiny, in which case the width is
given in amChart4Output
the height of the chart, e.g. "400px"
;
ignored if the chart is displayed in Shiny, in which case the height is
given in amChart4Output
logical, whether to enable the export menu
a HTML id for the chart
a HTML id for the container of the chart; ignored if the chart is displayed in Shiny, in which case the id is given by the Shiny id
library(rAmCharts4)
set.seed(666)
dat <- data.frame(
group = gl(4, 50, labels = c("A", "B", "C", "D")),
y = rt(200, df = 3)
)
amBoxplotChart(
dat,
category = "group",
value = "y",
color = "maroon",
valueFormatter = "#.#",
theme = "moonrisekingdom"
)
Run the code above in your browser using DataLab