Doc tweaks for fortify + autoplot

Author: hadley

R/fortify-lm.r

@@ -14,6 +14,7 @@
 #' @param model linear model
 #' @param data data set, defaults to data used to fit model
 #' @param ... not used by this method
+#' @keywords internal
 #' @export
 #' @examples
 #' mod <- lm(mpg ~ wt, data = mtcars)

R/fortify-map.r

@@ -1,4 +1,4 @@
-#' Fortify method for map objects.
+#' Fortify method for map objects
 #'
 #' This function turns a map into a data frame that can more easily be
 #' plotted with ggplot2.
@@ -8,6 +8,7 @@
 #' @param model map object
 #' @param data not used by this method
 #' @param ... not used by this method
+#' @keywords internal
 #' @examples
 #' if (require("maps")) {
 #' ca <- map("county", "ca", plot = FALSE, fill = TRUE)
@@ -32,7 +33,10 @@ fortify.map <- function(model, data, ...) {
   df[stats::complete.cases(df$lat, df$long), ]
 }
 
-#' Create a data frame of map data.
+#' Create a data frame of map data
+#'
+#' Easily turn data from the \pkg{maps} package in to a data frame suitable
+#' for plotting with ggplot2.
 #'
 #' @param map name of map provided by the \pkg{maps} package.  These
 #'   include \code{\link[maps]{county}}, \code{\link[maps]{france}},
@@ -45,6 +49,7 @@ fortify.map <- function(model, data, ...) {
 #' @param exact should the \code{region} be treated as a regular expression
 #'   (\code{FALSE}) or as a fixed string (\code{TRUE}).
 #' @param ... all other arguments passed on to \code{\link[maps]{map}}
+#' @keywords internal
 #' @export
 #' @examples
 #' if (require("maps")) {

R/fortify-multcomp.r

@@ -4,6 +4,7 @@
 #'  \code{summary.glht} or \code{\link[multcomp]{cld}}
 #' @param data,... other arguments to the generic ignored in this method.
 #' @name fortify-multcomp
+#' @keywords internal
 #' @examples
 #' if (require("multcomp")) {
 #' amod <- aov(breaks ~ wool + tension, data = warpbreaks)

R/fortify-spatial.r

@@ -7,6 +7,7 @@
 #' @param data not used by this method
 #' @param region name of variable used to split up regions
 #' @param ... not used by this method
+#' @keywords internal
 #' @name fortify.sp
 #' @examples
 #' if (require("maptools")) {

_pkgdown.yml

@@ -146,7 +146,7 @@ reference:
   - aes_
   - print.ggplot
 
-- title: Extending ggplot2 with ggproto
+- title: Extending ggplot2
   desc: >
     To create your own geoms, stats, scales, and facets, you'll need to learn
     a bit about the object oriented system that ggplot2 uses. Start by
@@ -156,16 +156,6 @@ reference:
   - ggproto
   - print.ggproto
 
-- title: Autoplot and fortify
-  contents:
-  - autoplot
-  - fortify-multcomp
-  - fortify.lm
-  - fortify.map
-  - fortify
-  - fortify.sp
-  - map_data
-
 - title: Vector helpers
   contents:
   - cut_interval
@@ -200,3 +190,14 @@ reference:
   - txhousing
   - luv_colours
 
+- title: Autoplot and fortify
+  desc: >
+    `autoplot()` is an extension mechansim for ggplot2 it provides a way
+    for package authors to add methods that work like the base `plot()`
+    function, generating useful default plots with little user interaction.
+    `fortify()` turns objects into tidy data frames: it has largely been
+    superceded by the [broom package](https://github.com/dgrtwo/broom).
+  contents:
+  - autoplot
+  - fortify
+  - map_data