Skip to content

Commit a2f38b8

Browse files
committed
clarify documentation
1 parent dff8b54 commit a2f38b8

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

R/geom-violin.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
#' @param quantile.colour,quantile.color,quantile.linewidth,quantile.linetype
2525
#' Default aesthetics for the quantile lines. Set to `NULL` to inherit from
2626
#' the data's aesthetics. By default, quantile lines are hidden and can be
27-
#' turned on by changing `quantile.linetype`.
27+
#' turned on by changing `quantile.linetype`. Quantile values can be set
28+
#' using the `quantiles` argument when using `stat = "ydensity"` (default).
2829
#' @param draw_quantiles `r lifecycle::badge("deprecated")` Previous
2930
#' specification of drawing quantiles.
3031
#' @export

R/stat-ydensity.R

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,11 @@ StatYdensity <- ggproto(
137137
#' @param drop Whether to discard groups with less than 2 observations
138138
#' (`TRUE`, default) or keep such groups for position adjustment purposes
139139
#' (`FALSE`).
140-
#' @param quantiles If not `NULL` (default), compute the `quantile` variable
141-
#' and draw horizontal lines at the given quantiles in `geom_violin()`.
140+
#' @param quantiles A numeric vector with numbers between 0 and 1 to indicate
141+
#' quantiles marked by the `quantile` computed variable. The default marks the
142+
#' 25th, 50th and 75th percentiles. The display of quantiles can be
143+
#' turned on by setting `quantile.linetype` to non-blank when using
144+
#' `geom = "violin"` (default).
142145
#'
143146
#' @eval rd_computed_vars(
144147
#' density = "Density estimate.",

man/geom_violin.Rd

Lines changed: 7 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)