From 627666bd19615eb16835d8b14e0a1fa91d55d5cc Mon Sep 17 00:00:00 2001 From: Hiroaki Yutani Date: Sat, 11 Jul 2020 10:37:24 +0900 Subject: [PATCH 1/4] Update doc of stat_boxplot() --- DESCRIPTION | 2 +- R/stat-boxplot.r | 10 +++++----- man/geom_boxplot.Rd | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a7f1745780..383dd5a511 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -263,6 +263,6 @@ Collate: 'zxx.r' 'zzz.r' VignetteBuilder: knitr -RoxygenNote: 7.1.0.9000 +RoxygenNote: 7.1.1 Roxygen: list(markdown = TRUE) Encoding: UTF-8 diff --git a/R/stat-boxplot.r b/R/stat-boxplot.r index 762bfac606..8b623ff09f 100644 --- a/R/stat-boxplot.r +++ b/R/stat-boxplot.r @@ -4,13 +4,13 @@ #' @section Computed variables: #' \describe{ #' \item{width}{width of boxplot} -#' \item{ymin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} -#' \item{lower}{lower hinge, 25% quantile} +#' \item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} +#' \item{lower or xlower}{lower hinge, 25% quantile} #' \item{notchlower}{lower edge of notch = median - 1.58 * IQR / sqrt(n)} -#' \item{middle}{median, 50% quantile} +#' \item{middle or xmiddle}{median, 50% quantile} #' \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} -#' \item{upper}{upper hinge, 75% quantile} -#' \item{ymax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +#' \item{upper or xupper}{upper hinge, 75% quantile} +#' \item{ymax or xmin}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} #' } #' @export stat_boxplot <- function(mapping = NULL, data = NULL, diff --git a/man/geom_boxplot.Rd b/man/geom_boxplot.Rd index 9961f3fa96..946f7ea62a 100644 --- a/man/geom_boxplot.Rd +++ b/man/geom_boxplot.Rd @@ -174,13 +174,13 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \describe{ \item{width}{width of boxplot} -\item{ymin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} -\item{lower}{lower hinge, 25\% quantile} +\item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} +\item{lower or xlower}{lower hinge, 25\% quantile} \item{notchlower}{lower edge of notch = median - 1.58 * IQR / sqrt(n)} -\item{middle}{median, 50\% quantile} +\item{middle or xmiddle}{median, 50\% quantile} \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} -\item{upper}{upper hinge, 75\% quantile} -\item{ymax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +\item{upper or xupper}{upper hinge, 75\% quantile} +\item{ymax or xmin}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} } } From 0020aefabd56dddcd0b4f3b8b1c963f1c0397db4 Mon Sep 17 00:00:00 2001 From: Hiroaki Yutani Date: Sat, 11 Jul 2020 10:38:16 +0900 Subject: [PATCH 2/4] Update doc of stat_smooth() --- R/stat-smooth.r | 6 +++--- man/geom_smooth.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/stat-smooth.r b/R/stat-smooth.r index 31a7941bb2..ddb9389e35 100644 --- a/R/stat-smooth.r +++ b/R/stat-smooth.r @@ -31,9 +31,9 @@ #' function defined by `method`. #' @section Computed variables: #' \describe{ -#' \item{y}{predicted value} -#' \item{ymin}{lower pointwise confidence interval around the mean} -#' \item{ymax}{upper pointwise confidence interval around the mean} +#' \item{y or x}{predicted value} +#' \item{ymin or xmin}{lower pointwise confidence interval around the mean} +#' \item{ymax or xmax}{upper pointwise confidence interval around the mean} #' \item{se}{standard error} #' } #' @export diff --git a/man/geom_smooth.Rd b/man/geom_smooth.Rd index e91fc73a65..f02e24db8b 100644 --- a/man/geom_smooth.Rd +++ b/man/geom_smooth.Rd @@ -171,9 +171,9 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \section{Computed variables}{ \describe{ -\item{y}{predicted value} -\item{ymin}{lower pointwise confidence interval around the mean} -\item{ymax}{upper pointwise confidence interval around the mean} +\item{y or x}{predicted value} +\item{ymin or xmin}{lower pointwise confidence interval around the mean} +\item{ymax or xmax}{upper pointwise confidence interval around the mean} \item{se}{standard error} } } From 9d66d8d1c168751a8377b8fa9904657cddcf820f Mon Sep 17 00:00:00 2001 From: Hiroaki Yutani Date: Sun, 12 Jul 2020 08:13:00 +0900 Subject: [PATCH 3/4] Explain some depend on orientation and fix a typo --- R/stat-boxplot.r | 3 ++- R/stat-smooth.r | 1 + man/geom_boxplot.Rd | 3 ++- man/geom_smooth.Rd | 1 + 4 files changed, 6 insertions(+), 2 deletions(-) diff --git a/R/stat-boxplot.r b/R/stat-boxplot.r index 8b623ff09f..66abcaa4f1 100644 --- a/R/stat-boxplot.r +++ b/R/stat-boxplot.r @@ -2,6 +2,7 @@ #' @param coef Length of the whiskers as multiple of IQR. Defaults to 1.5. #' @inheritParams stat_identity #' @section Computed variables: +#' `stat_boxplot()` provides the following variables, some of which depend on the orientation: #' \describe{ #' \item{width}{width of boxplot} #' \item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} @@ -10,7 +11,7 @@ #' \item{middle or xmiddle}{median, 50% quantile} #' \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} #' \item{upper or xupper}{upper hinge, 75% quantile} -#' \item{ymax or xmin}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +#' \item{ymax or xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} #' } #' @export stat_boxplot <- function(mapping = NULL, data = NULL, diff --git a/R/stat-smooth.r b/R/stat-smooth.r index ddb9389e35..5325625848 100644 --- a/R/stat-smooth.r +++ b/R/stat-smooth.r @@ -30,6 +30,7 @@ #' @param method.args List of additional arguments passed on to the modelling #' function defined by `method`. #' @section Computed variables: +#' `stat_smooth()` provides the following variables, some of which depend on the orientation: #' \describe{ #' \item{y or x}{predicted value} #' \item{ymin or xmin}{lower pointwise confidence interval around the mean} diff --git a/man/geom_boxplot.Rd b/man/geom_boxplot.Rd index 946f7ea62a..35129045a7 100644 --- a/man/geom_boxplot.Rd +++ b/man/geom_boxplot.Rd @@ -172,6 +172,7 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \section{Computed variables}{ +\code{stat_boxplot()} provides the following variables, some of which depend on the orientation: \describe{ \item{width}{width of boxplot} \item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} @@ -180,7 +181,7 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \item{middle or xmiddle}{median, 50\% quantile} \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} \item{upper or xupper}{upper hinge, 75\% quantile} -\item{ymax or xmin}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +\item{ymax or xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} } } diff --git a/man/geom_smooth.Rd b/man/geom_smooth.Rd index f02e24db8b..5eedbcc47a 100644 --- a/man/geom_smooth.Rd +++ b/man/geom_smooth.Rd @@ -170,6 +170,7 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \section{Computed variables}{ +\code{stat_smooth()} provides the following variables, some of which depend on the orientation: \describe{ \item{y or x}{predicted value} \item{ymin or xmin}{lower pointwise confidence interval around the mean} From ad5534e12f758efbd043cf54487f20245ce8fc07 Mon Sep 17 00:00:00 2001 From: Hiroaki Yutani Date: Sun, 12 Jul 2020 08:58:48 +0900 Subject: [PATCH 4/4] Put "or"s in Italic --- R/stat-boxplot.r | 10 +++++----- R/stat-smooth.r | 6 +++--- man/geom_boxplot.Rd | 10 +++++----- man/geom_smooth.Rd | 6 +++--- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/R/stat-boxplot.r b/R/stat-boxplot.r index 66abcaa4f1..a1b3a7bfa8 100644 --- a/R/stat-boxplot.r +++ b/R/stat-boxplot.r @@ -5,13 +5,13 @@ #' `stat_boxplot()` provides the following variables, some of which depend on the orientation: #' \describe{ #' \item{width}{width of boxplot} -#' \item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} -#' \item{lower or xlower}{lower hinge, 25% quantile} +#' \item{ymin *or* xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} +#' \item{lower *or* xlower}{lower hinge, 25% quantile} #' \item{notchlower}{lower edge of notch = median - 1.58 * IQR / sqrt(n)} -#' \item{middle or xmiddle}{median, 50% quantile} +#' \item{middle *or* xmiddle}{median, 50% quantile} #' \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} -#' \item{upper or xupper}{upper hinge, 75% quantile} -#' \item{ymax or xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +#' \item{upper *or* xupper}{upper hinge, 75% quantile} +#' \item{ymax *or* xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} #' } #' @export stat_boxplot <- function(mapping = NULL, data = NULL, diff --git a/R/stat-smooth.r b/R/stat-smooth.r index 5325625848..ad9b438967 100644 --- a/R/stat-smooth.r +++ b/R/stat-smooth.r @@ -32,9 +32,9 @@ #' @section Computed variables: #' `stat_smooth()` provides the following variables, some of which depend on the orientation: #' \describe{ -#' \item{y or x}{predicted value} -#' \item{ymin or xmin}{lower pointwise confidence interval around the mean} -#' \item{ymax or xmax}{upper pointwise confidence interval around the mean} +#' \item{y *or* x}{predicted value} +#' \item{ymin *or* xmin}{lower pointwise confidence interval around the mean} +#' \item{ymax *or* xmax}{upper pointwise confidence interval around the mean} #' \item{se}{standard error} #' } #' @export diff --git a/man/geom_boxplot.Rd b/man/geom_boxplot.Rd index 35129045a7..c137d12059 100644 --- a/man/geom_boxplot.Rd +++ b/man/geom_boxplot.Rd @@ -175,13 +175,13 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \code{stat_boxplot()} provides the following variables, some of which depend on the orientation: \describe{ \item{width}{width of boxplot} -\item{ymin or xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} -\item{lower or xlower}{lower hinge, 25\% quantile} +\item{ymin \emph{or} xmin}{lower whisker = smallest observation greater than or equal to lower hinge - 1.5 * IQR} +\item{lower \emph{or} xlower}{lower hinge, 25\% quantile} \item{notchlower}{lower edge of notch = median - 1.58 * IQR / sqrt(n)} -\item{middle or xmiddle}{median, 50\% quantile} +\item{middle \emph{or} xmiddle}{median, 50\% quantile} \item{notchupper}{upper edge of notch = median + 1.58 * IQR / sqrt(n)} -\item{upper or xupper}{upper hinge, 75\% quantile} -\item{ymax or xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} +\item{upper \emph{or} xupper}{upper hinge, 75\% quantile} +\item{ymax \emph{or} xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR} } } diff --git a/man/geom_smooth.Rd b/man/geom_smooth.Rd index 5eedbcc47a..95c11217cb 100644 --- a/man/geom_smooth.Rd +++ b/man/geom_smooth.Rd @@ -172,9 +172,9 @@ Learn more about setting these aesthetics in \code{vignette("ggplot2-specs")}. \code{stat_smooth()} provides the following variables, some of which depend on the orientation: \describe{ -\item{y or x}{predicted value} -\item{ymin or xmin}{lower pointwise confidence interval around the mean} -\item{ymax or xmax}{upper pointwise confidence interval around the mean} +\item{y \emph{or} x}{predicted value} +\item{ymin \emph{or} xmin}{lower pointwise confidence interval around the mean} +\item{ymax \emph{or} xmax}{upper pointwise confidence interval around the mean} \item{se}{standard error} } }