coord_quickmap: document 'expand' argument. Closes #1356

tidyverse · Sep 25, 2015 · cbfe1c3 · cbfe1c3
1 parent a293c55
commit cbfe1c3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/R/coord-quickmap.R b/R/coord-quickmap.R
@@ -1,3 +1,4 @@
+#' @inheritParams coord_cartesian
 #' @export
 #' @rdname coord_map
 coord_quickmap <- function(xlim = NULL, ylim = NULL, expand = TRUE) {

diff --git a/man/coord_map.Rd b/man/coord_map.Rd
@@ -25,6 +25,10 @@ projections, so you will have to supply your own. See
 \item{xlim}{manually specific x limits (in degrees of longitude)}
 
 \item{ylim}{manually specific y limits (in degrees of latitude)}
+
+\item{expand}{If \code{TRUE}, the default, adds a small expansion factor to
+the limits to ensure that data and axes don't overlap. If \code{FALSE},
+limits are taken exactly from the data or \code{xlim}/\code{ylim}.}
 }
 \description{
 The representation of a portion of the earth, which is approximately spherical,