Skip to content

Commit 2ac58ca

Browse files
Document flipped computed variables (#4128)
* Update doc of stat_boxplot() * Update doc of stat_smooth() * Explain some depend on orientation and fix a typo * Put "or"s in Italic
1 parent 800af57 commit 2ac58ca

File tree

5 files changed

+21
-17
lines changed

5 files changed

+21
-17
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,6 @@ Collate:
263263
'zxx.r'
264264
'zzz.r'
265265
VignetteBuilder: knitr
266-
RoxygenNote: 7.1.0.9000
266+
RoxygenNote: 7.1.1
267267
Roxygen: list(markdown = TRUE)
268268
Encoding: UTF-8

R/stat-boxplot.r

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
#' @param coef Length of the whiskers as multiple of IQR. Defaults to 1.5.
33
#' @inheritParams stat_identity
44
#' @section Computed variables:
5+
#' `stat_boxplot()` provides the following variables, some of which depend on the orientation:
56
#' \describe{
67
#' \item{width}{width of boxplot}
7-
#' \item{ymin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR}
8-
#' \item{lower}{lower hinge, 25% quantile}
8+
#' \item{ymin *or* xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR}
9+
#' \item{lower *or* xlower}{lower hinge, 25% quantile}
910
#' \item{notchlower}{lower edge of notch = median - 1.58 * IQR / sqrt(n)}
10-
#' \item{middle}{median, 50% quantile}
11+
#' \item{middle *or* xmiddle}{median, 50% quantile}
1112
#' \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)}
12-
#' \item{upper}{upper hinge, 75% quantile}
13-
#' \item{ymax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR}
13+
#' \item{upper *or* xupper}{upper hinge, 75% quantile}
14+
#' \item{ymax *or* xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR}
1415
#' }
1516
#' @export
1617
stat_boxplot <- function(mapping = NULL, data = NULL,

R/stat-smooth.r

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@
3030
#' @param method.args List of additional arguments passed on to the modelling
3131
#' function defined by `method`.
3232
#' @section Computed variables:
33+
#' `stat_smooth()` provides the following variables, some of which depend on the orientation:
3334
#' \describe{
34-
#' \item{y}{predicted value}
35-
#' \item{ymin}{lower pointwise confidence interval around the mean}
36-
#' \item{ymax}{upper pointwise confidence interval around the mean}
35+
#' \item{y *or* x}{predicted value}
36+
#' \item{ymin *or* xmin}{lower pointwise confidence interval around the mean}
37+
#' \item{ymax *or* xmax}{upper pointwise confidence interval around the mean}
3738
#' \item{se}{standard error}
3839
#' }
3940
#' @export

man/geom_boxplot.Rd

Lines changed: 6 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/geom_smooth.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)