Skip to content

geom_smooth(): Updated documentation, "confidence intervals" to "confidence bands" #6040

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.

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 1 commit into from
Aug 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 R/geom-smooth.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#' `predictdf()` generic and its methods. For most methods the standard
#' error bounds are computed using the [predict()] method -- the
#' exceptions are `loess()`, which uses a t-based approximation, and
#' `glm()`, where the normal confidence interval is constructed on the link
#' `glm()`, where the normal confidence band is constructed on the link
#' scale and then back-transformed to the response scale.
#'
#' @eval rd_orientation()
Expand Down
8 changes: 4 additions & 4 deletions R/stat-smooth.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@
#' `y ~ poly(x, 2)`, `y ~ log(x)`. `NULL` by default, in which case
#' `method = NULL` implies `formula = y ~ x` when there are fewer than 1,000
#' observations and `formula = y ~ s(x, bs = "cs")` otherwise.
#' @param se Display confidence interval around smooth? (`TRUE` by default, see
#' @param se Display confidence band around smooth? (`TRUE` by default, see
#' `level` to control.)
#' @param fullrange If `TRUE`, the smoothing line gets expanded to the range of the plot,
#' potentially beyond the data. This does not extend the line into any additional padding
#' created by `expansion`.
#' @param xseq A numeric vector of values at which the smoother is evaluated.
#' When `NULL` (default), `xseq` is internally evaluated as a sequence of `n`
#' equally spaced points for continuous data.
#' @param level Level of confidence interval to use (0.95 by default).
#' @param level Level of confidence band to use (0.95 by default).
#' @param span Controls the amount of smoothing for the default loess smoother.
#' Smaller numbers produce wigglier lines, larger numbers produce smoother
#' lines. Only used with loess, i.e. when `method = "loess"`,
Expand All @@ -40,8 +40,8 @@
#' .details = "`stat_smooth()` provides the following variables, some of
#' which depend on the orientation:",
#' "y|x" = "Predicted value.",
#' "ymin|xmin" = "Lower pointwise confidence interval around the mean.",
#' "ymax|xmax" = "Upper pointwise confidence interval around the mean.",
#' "ymin|xmin" = "Lower pointwise confidence band around the mean.",
#' "ymax|xmax" = "Upper pointwise confidence band around the mean.",
#' "se" = "Standard error."
#' )
#' @export
Expand Down
10 changes: 5 additions & 5 deletions man/geom_smooth.Rd

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

Loading