% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ms_boxplotchart.R
\name{ms_boxplotchart}
\alias{ms_boxplotchart}
\title{Boxplot chart object}
\usage{
ms_boxplotchart(
  data,
  x,
  y,
  quartile_method = c("exclusive", "inclusive"),
  show_mean_marker = TRUE,
  show_mean_line = FALSE,
  show_outliers = TRUE,
  show_inner_points = FALSE
)
}
\arguments{
\item{data}{a data.frame.}

\item{x}{category column name. Each unique value becomes one box.}

\item{y}{numeric value column name (raw observations).}

\item{quartile_method}{one of \code{"exclusive"} (default) or \code{"inclusive"}.
Affects how Q1/Q3 are computed when the count is even.}

\item{show_mean_marker}{logical, draw the mean as a marker. Default TRUE.}

\item{show_mean_line}{logical, draw a line connecting means across
boxes. Default FALSE.}

\item{show_outliers}{logical, plot outlier points. Default TRUE.}

\item{show_inner_points}{logical, plot all non-outlier points. Default FALSE.}
}
\value{
An \code{ms_chart} object (subclass \code{ms_boxplotchart}).
}
\description{
Creation of a box-and-whisker chart object that can be
inserted in a 'Microsoft' document. Boxplot charts use the chartEx
pipeline (Office 2016+); older versions of 'Microsoft Office' will
display a fallback placeholder.

Data is in long format: one row per observation. Office computes
quartiles and whiskers from the raw values; do not pre-aggregate.
}
\examples{
library(officer)

set.seed(1)
dat <- data.frame(
  group = rep(c("A", "B", "C"), each = 20),
  value = c(rnorm(20, 0, 5), rnorm(20, 3, 7), rnorm(20, -2, 4))
)
bp <- ms_boxplotchart(dat, x = "group", y = "value")

doc <- read_pptx()
doc <- add_slide(doc)
doc <- ph_with(doc, bp, location = ph_location_fullsize())
print(doc, target = tempfile(fileext = ".pptx"))
}
\seealso{
\code{\link[=chart_labels]{chart_labels()}}

Other 'Office' chart objects:
\code{\link[=ms_areachart]{ms_areachart()}},
\code{\link[=ms_barchart]{ms_barchart()}},
\code{\link[=ms_bubblechart]{ms_bubblechart()}},
\code{\link[=ms_chart_combine]{ms_chart_combine()}},
\code{\link[=ms_funnelchart]{ms_funnelchart()}},
\code{\link[=ms_histogramchart]{ms_histogramchart()}},
\code{\link[=ms_linechart]{ms_linechart()}},
\code{\link[=ms_paretochart]{ms_paretochart()}},
\code{\link[=ms_piechart]{ms_piechart()}},
\code{\link[=ms_radarchart]{ms_radarchart()}},
\code{\link[=ms_scatterchart]{ms_scatterchart()}},
\code{\link[=ms_stockchart]{ms_stockchart()}},
\code{\link[=ms_sunburstchart]{ms_sunburstchart()}},
\code{\link[=ms_treemapchart]{ms_treemapchart()}},
\code{\link[=ms_waterfallchart]{ms_waterfallchart()}}
}
\concept{'Office' chart objects}
