Skip to content

Commit ec2468f

Browse files
committed
Final doc tweaks
1 parent d012843 commit ec2468f

9 files changed

+32
-24
lines changed

R/aes-group-order.r

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#' Aesthetics: group
1+
#' Aesthetics: grouping
22
#'
33
#' @name aes_group_order
44
#' @aliases group

R/quick-plot.r

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
#' Quick plot
22
#'
3-
#' \code{qplot} is the basic plotting function in the ggplot2 package,
4-
#' designed to be familiar if you're used to base \code{\link{plot}()}.
5-
#' It's a convenient wrapper for creating a number of different types of plots
6-
#' using a consistent calling scheme.
3+
#' \code{qplot} is a shortcut designed to be familiar if you're used to base
4+
#' \code{\link{plot}()}. It's a convenient wrapper for creating a number of
5+
#' different types of plots using a consistent calling scheme. It's great
6+
#' for allowing you to produce plots quickly, but I highly recommend
7+
#' learning \code{\link{ggplot}()} as it makes it easier to create
8+
#' complex graphics.
79
#'
810
#' @param x,y,... Aesthetics passed into each layer
911
#' @param data Data frame to use (optional). If not specified, will create

R/translate-qplot-ggplot.r

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
#' describes what those defaults are, and how they map to the fuller ggplot()
88
#' syntax.
99
#'
10+
#' @keywords internal
1011
#' @name translate_qplot_ggplot
1112
#' @examples
1213
#'

R/translate-qplot-lattice.r

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#' formula based interface. ggplot2 does not because the formula does not
55
#' generalise well to more complicated situations.
66
#'
7+
#' @keywords internal
78
#' @name translate_qplot_lattice
89
#' @examples
910
#' \donttest{

_pkgdown.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ reference:
1212
- title: Plot basics
1313
desc: >
1414
All ggplot2 plots with a call to `ggplot()`, supplying default data and
15-
aesthethic mappings, specified by `aes()`. You then add components (listed
16-
below) with `+`. To save a plot to disk, use `ggsave()`.
15+
aesthethic mappings, specified by `aes()`. You then add layers, scales,
16+
coords and facets with `+`. To save a plot to disk, use `ggsave()`.
1717
contents:
1818
- ggplot
1919
- aes
2020
- +.gg
2121
- ggsave
22+
- qplot
2223

2324
- title: "Layer: geoms"
2425
desc: >
@@ -64,6 +65,16 @@ reference:
6465
- annotation_raster
6566
- borders
6667

68+
- title: Aesthetics
69+
desc: >
70+
The following help topics give a broad overview of some of the ways
71+
you can use each aesthetic
72+
contents:
73+
- aes_colour_fill_alpha
74+
- aes_group_order
75+
- aes_linetype_size_shape
76+
- aes_position
77+
6778
- title: Scales
6879
desc: >
6980
Scales control the details of how data values are translated to visual
@@ -166,17 +177,6 @@ reference:
166177
- mean_se
167178
- resolution
168179

169-
- title: All functions
170-
desc: ~
171-
contents:
172-
- aes_colour_fill_alpha
173-
- aes_group_order
174-
- aes_linetype_size_shape
175-
- aes_position
176-
- translate_qplot_ggplot
177-
- translate_qplot_lattice
178-
- qplot
179-
180180
- title: Data
181181
desc: >
182182
ggplot2 comes with a selection of built-in datasets that are used in

man/aes_group_order.Rd

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

man/qplot.Rd

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

man/translate_qplot_ggplot.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/translate_qplot_lattice.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)