Skip to content

Commit eb0010e

Browse files
authored
improve docs (#4838)
1 parent 3932165 commit eb0010e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+272
-126
lines changed

R/layer.r

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,17 @@
2323
#' the plot data. The return value must be a `data.frame`, and
2424
#' will be used as the layer data. A `function` can be created
2525
#' from a `formula` (e.g. `~ head(.x, 10)`).
26-
#' @param geom The geometric object to use display the data
26+
#' @param geom The geometric object to use to display the data, either as a
27+
#' `ggproto` `Geom` subclass or as a string naming the geom stripped of the
28+
#' `geom_` prefix (e.g. `"point"` rather than `"geom_point"`)
2729
#' @param stat The statistical transformation to use on the data for this
28-
#' layer, as a string.
29-
#' @param position Position adjustment, either as a string, or the result of
30-
#' a call to a position adjustment function.
30+
#' layer, either as a `ggproto` `Geom` subclass or as a string naming the
31+
#' stat stripped of the `stat_` prefix (e.g. `"count"` rather than
32+
#' `"stat_count"`)
33+
#' @param position Position adjustment, either as a string naming the adjustment
34+
#' (e.g. `"jitter"` to use `position_jitter`), or the result of a call to a
35+
#' position adjustment function. Use the latter if you need to change the
36+
#' settings of the adjustment.
3137
#' @param show.legend logical. Should this layer be included in the legends?
3238
#' `NA`, the default, includes if any aesthetics are mapped.
3339
#' `FALSE` never includes, and `TRUE` always includes.

man/borders.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.

man/geom_bar.Rd

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

man/geom_bin_2d.Rd

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

man/geom_blank.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.

man/geom_boxplot.Rd

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

man/geom_contour.Rd

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

man/geom_count.Rd

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

man/geom_density.Rd

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

man/geom_density_2d.Rd

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

man/geom_dotplot.Rd

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

man/geom_errorbarh.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.

man/geom_function.Rd

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

man/geom_hex.Rd

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

man/geom_histogram.Rd

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

man/geom_jitter.Rd

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

man/geom_linerange.Rd

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

man/geom_map.Rd

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

man/geom_path.Rd

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

man/geom_point.Rd

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

man/geom_polygon.Rd

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

0 commit comments

Comments
 (0)