Doc fixes

Author: hadley

R/scale-brewer.r

@@ -14,6 +14,7 @@
 #' @inheritParams scales::brewer_pal
 #' @inheritParams scale_colour_hue
 #' @inheritParams scale_colour_gradient
+#' @inheritParams scales::gradient_n_pal
 #' @family colour scales
 #' @rdname scale_brewer
 #' @export
@@ -89,7 +90,7 @@ scale_fill_distiller <- function(..., type = "seq", palette = 1, values = NULL,
 }
 
 # icon.brewer <- function() {
-#   rectGrob(c(0.1, 0.3, 0.5, 0.7, 0.9), width = 0.21, 
+#   rectGrob(c(0.1, 0.3, 0.5, 0.7, 0.9), width = 0.21,
 #     gp = gpar(fill = RColorBrewer::brewer.pal(5, "PuOr"), col = NA)
 #   )
 # }

R/theme-defaults.r

@@ -8,29 +8,29 @@
 #'
 #' @details \describe{
 #'
-#' \item{\code{theme_gray}}
-#' {The signature ggplot2 theme with a grey background and white gridlines,
+#' \item{\code{theme_gray}}{
+#' The signature ggplot2 theme with a grey background and white gridlines,
 #' designed to put the data forward yet make comparisons easy.}
 #'
-#' \item{\code{theme_bw}}
-#' {The classic dark-on-light ggplot2 theme. May work better for presentations
+#' \item{\code{theme_bw}}{
+#' The classic dark-on-light ggplot2 theme. May work better for presentations
 #' displayed with a projector.}
 #'
-#' \item{\code{theme_linedraw}}
-#' {A theme with only black lines of various widths on white backgrounds,
+#' \item{\code{theme_linedraw}}{
+#' A theme with only black lines of various widths on white backgrounds,
 #' reminiscent of a line drawings. Serves a purpose similar to \code{theme_bw}.
 #' Note that this theme has some very thin lines (<< 1 pt) which some journals
 #' may refuse.}
 #'
-#' \item{\code{theme_light}}
-#' {A theme similar to \code{theme_linedraw} but with light grey lines and axes,
+#' \item{\code{theme_light}}{
+#' A theme similar to \code{theme_linedraw} but with light grey lines and axes,
 #' to direct more attention towards the data.}
 #'
-#' \item{\code{theme_minimal}}
-#' {A minimalistic theme with no background annotations.}
+#' \item{\code{theme_minimal}}{
+#' A minimalistic theme with no background annotations.}
 #'
-#' \item{\code{theme_classic}}
-#' {A classic-looking theme, with x and y axis lines and no gridlines.}
+#' \item{\code{theme_classic}}{
+#' A classic-looking theme, with x and y axis lines and no gridlines.}
 #'
 #' }
 #'

man/ggtheme.Rd

@@ -36,29 +36,29 @@ background, gridlines, the size and colour of fonts.
 \details{
 \describe{
 
-\item{\code{theme_gray}}
-{The signature ggplot2 theme with a grey background and white gridlines,
+\item{\code{theme_gray}}{
+The signature ggplot2 theme with a grey background and white gridlines,
 designed to put the data forward yet make comparisons easy.}
 
-\item{\code{theme_bw}}
-{The classic dark-on-light ggplot2 theme. May work better for presentations
+\item{\code{theme_bw}}{
+The classic dark-on-light ggplot2 theme. May work better for presentations
 displayed with a projector.}
 
-\item{\code{theme_linedraw}}
-{A theme with only black lines of various widths on white backgrounds,
+\item{\code{theme_linedraw}}{
+A theme with only black lines of various widths on white backgrounds,
 reminiscent of a line drawings. Serves a purpose similar to \code{theme_bw}.
 Note that this theme has some very thin lines (<< 1 pt) which some journals
 may refuse.}
 
-\item{\code{theme_light}}
-{A theme similar to \code{theme_linedraw} but with light grey lines and axes,
+\item{\code{theme_light}}{
+A theme similar to \code{theme_linedraw} but with light grey lines and axes,
 to direct more attention towards the data.}
 
-\item{\code{theme_minimal}}
-{A minimalistic theme with no background annotations.}
+\item{\code{theme_minimal}}{
+A minimalistic theme with no background annotations.}
 
-\item{\code{theme_classic}}
-{A classic-looking theme, with x and y axis lines and no gridlines.}
+\item{\code{theme_classic}}{
+A classic-looking theme, with x and y axis lines and no gridlines.}
 
 }
 }

man/scale_brewer.Rd

@@ -35,6 +35,15 @@ scale_color_distiller(..., type = "seq", palette = 1, values = NULL,
 to control name, limits, breaks, labels and so forth.}
 
 \item{na.value}{Colour to use for missing values}
+
+\item{values}{if colours should not be evenly positioned
+  along the gradient this vector gives the position
+  (between 0 and 1) for each colour in the \code{colours}
+  vector. See \code{\link{rescale}} for a convience
+  function to map an arbitrary range to between 0 and 1.}
+
+\item{space}{colour space in which to calculate gradient.
+  "Lab" usually best unless gradient goes through white.}
 }
 \description{
 ColorBrewer provides sequential, diverging and qualitative colour schemes