Skip to content

Document flipped computed variables #4128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 12, 2020
Merged

Document flipped computed variables #4128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
627666b
Update doc of stat_boxplot()
yutannihilation Jul 11, 2020
0020aef
Update doc of stat_smooth()
yutannihilation Jul 11, 2020
9d66d8d
Explain some depend on orientation and fix a typo
yutannihilation Jul 11, 2020
ad5534e
Put "or"s in Italic
yutannihilation Jul 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 6 additions & 5 deletions R/stat-boxplot.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,16 @@
#' @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}{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* xmax}{upper whisker = largest observation less than or equal to upper hinge + 1.5 * IQR}
#' }
#' @export
stat_boxplot <- function(mapping = NULL, data = NULL,
Expand Down
7 changes: 4 additions & 3 deletions R/stat-smooth.r
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@
#' @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}{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
Expand Down
11 changes: 6 additions & 5 deletions man/geom_boxplot.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions man/geom_smooth.Rd
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.