Examples updated for ggplot2

eclarke · Dec 24, 2015 · 060b634 · 060b634
1 parent f00108b
commit 060b634
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 14 deletions.
diff --git a/R/geom-beeswarm.R b/R/geom-beeswarm.R
@@ -16,6 +16,17 @@
 #'  \code{\link[ggplot2]{geom_boxplot}} for another way of looking at the conditional
 #'     distribution of a variable
 #' @export
+#' @examples
+#' 
+#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='beeswarm')
+#'   # Generate fake data
+#'   distro <- data.frame(
+#'     'variable'=rep(c('runif','rnorm'),each=100),
+#'     'value'=c(runif(100, min=-3, max=3), rnorm(100))
+#'   )
+#'   ggplot2::qplot(variable, value, data = distro, geom='beeswarm')
+#'   ggplot2::qplot(variable, value, data = distro) +
+#'     geom_beeswarm(priority='density',cex=2.5)
 geom_beeswarm <- function(mapping = NULL, data = NULL,
   priority = c("ascending", "descending", "density", "random", "none"),cex=2,groupOnX=NULL,
   stat='identity',position = "quasirandom", na.rm = FALSE,

diff --git a/R/geom-quasirandom.R b/R/geom-quasirandom.R
@@ -14,6 +14,15 @@
 #'  \code{\link[ggplot2]{geom_jitter}} for jittered points,
 #'  \code{\link{geom_boxplot}} for another way of looking at the conditional
 #'     distribution of a variable
+#' @examples
+#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='quasirandom')
+#'   # Generate fake data
+#'   distro <- data.frame(
+#'     'variable'=rep(c('runif','rnorm'),each=100),
+#'     'value'=c(runif(100, min=-3, max=3), rnorm(100))
+#'   )
+#'   ggplot2::qplot(variable, value, data = distro, geom = 'quasirandom')
+#'   ggplot2::qplot(variable, value, data = distro) + geom_quasirandom(width=0.1)
 #' @export
 geom_quasirandom <- function(mapping = NULL, data = NULL,
   width = NULL, varwidth = FALSE, bandwidth=.5,nbins=1000,method='quasirandom',groupOnX=NULL,

diff --git a/R/position-beeswarm.R b/R/position-beeswarm.R
@@ -9,15 +9,15 @@
 #' @seealso \code{\link{position_quasirandom}}, \code{\link[beeswarm]{swarmx}} 
 #' @examples
 #' 
-#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, position=position_beeswarm())
+#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='beeswarm')
 #'   # Generate fake data
 #'   distro <- data.frame(
 #'     'variable'=rep(c('runif','rnorm'),each=100),
 #'     'value'=c(runif(100, min=-3, max=3), rnorm(100))
 #'   )
-#'   ggplot2::qplot(variable, value, data = distro, position = position_beeswarm())
-#'   ggplot2::qplot(variable, value, data = distro, position = 
-#'                  position_beeswarm(priority='density'),cex=2.5)
+#'   ggplot2::qplot(variable, value, data = distro, geom='beeswarm')
+#'   ggplot2::qplot(variable, value, data = distro) +
+#'     geom_beeswarm(priority='density',cex=2.5)
 #'
 position_beeswarm <- function (priority = c("ascending", "descending", "density", "random", "none"),cex=2,groupOnX=NULL) {
   ggplot2::ggproto(NULL,PositionBeeswarm,priority = priority,cex=cex,groupOnX=NULL)

diff --git a/R/position-quasirandom.R b/R/position-quasirandom.R
@@ -13,14 +13,14 @@
 #' @seealso \code{\link[vipor]{offsetX}}
 #' @examples
 #' 
-#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, position=position_quasirandom())
+#'   ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='quasirandom')
 #'   # Generate fake data
 #'   distro <- data.frame(
 #'     'variable'=rep(c('runif','rnorm'),each=100),
 #'     'value'=c(runif(100, min=-3, max=3), rnorm(100))
 #'   )
-#'   ggplot2::qplot(variable, value, data = distro, position = position_quasirandom())
-#'   ggplot2::qplot(variable, value, data = distro, position = position_quasirandom(width=0.1))
+#'   ggplot2::qplot(variable, value, data = distro, geom = 'quasirandom')
+#'   ggplot2::qplot(variable, value, data = distro) + geom_quasirandom(width=0.1)
 #'
 position_quasirandom <- function (width = NULL, varwidth = FALSE, bandwidth=.5,nbins=1000,method='quasirandom',groupOnX=NULL) {
   ggplot2::ggproto(NULL,PositionQuasirandom,width = width, varwidth = varwidth, bandwidth=bandwidth,nbins=nbins,method=method,groupOnX=groupOnX)

diff --git a/man/geom_beeswarm.Rd b/man/geom_beeswarm.Rd
@@ -61,6 +61,17 @@ The beeswarm geom is a convenient means to offset points within categories to re
 
 \Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("geom", "point")}
 }
+\examples{
+ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='beeswarm')
+  # Generate fake data
+  distro <- data.frame(
+    'variable'=rep(c('runif','rnorm'),each=100),
+    'value'=c(runif(100, min=-3, max=3), rnorm(100))
+  )
+  ggplot2::qplot(variable, value, data = distro, geom='beeswarm')
+  ggplot2::qplot(variable, value, data = distro) +
+    geom_beeswarm(priority='density',cex=2.5)
+}
 \seealso{
 \code{\link{geom_quasirandom}} an alternative method,
  \code{\link[beeswarm]{swarmx}} how spacing is determined,

diff --git a/man/geom_quasirandom.Rd b/man/geom_quasirandom.Rd
@@ -69,6 +69,16 @@ The quasirandom geom is a convenient means to offset points within categories to
 
 \Sexpr[results=rd,stage=build]{ggplot2:::rd_aesthetics("geom", "point")}
 }
+\examples{
+ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='quasirandom')
+  # Generate fake data
+  distro <- data.frame(
+    'variable'=rep(c('runif','rnorm'),each=100),
+    'value'=c(runif(100, min=-3, max=3), rnorm(100))
+  )
+  ggplot2::qplot(variable, value, data = distro, geom = 'quasirandom')
+  ggplot2::qplot(variable, value, data = distro) + geom_quasirandom(width=0.1)
+}
 \seealso{
 \code{\link[vipor]{offsetX}} how spacing is determined,
  \code{\link[ggplot2]{geom_point}} for regular, unjittered points,

diff --git a/man/position_beeswarm.Rd b/man/position_beeswarm.Rd
@@ -18,15 +18,15 @@ position_beeswarm(priority = c("ascending", "descending", "density", "random",
 Violin point-style plots to show overlapping points. x must be discrete.
 }
 \examples{
-ggplot2::qplot(class, hwy, data = ggplot2::mpg, position=position_beeswarm())
+ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='beeswarm')
   # Generate fake data
   distro <- data.frame(
     'variable'=rep(c('runif','rnorm'),each=100),
     'value'=c(runif(100, min=-3, max=3), rnorm(100))
   )
-  ggplot2::qplot(variable, value, data = distro, position = position_beeswarm())
-  ggplot2::qplot(variable, value, data = distro, position =
-                 position_beeswarm(priority='density'),cex=2.5)
+  ggplot2::qplot(variable, value, data = distro, geom='beeswarm')
+  ggplot2::qplot(variable, value, data = distro) +
+    geom_beeswarm(priority='density',cex=2.5)
 }
 \seealso{
 \code{\link{position_quasirandom}}, \code{\link[beeswarm]{swarmx}}

diff --git a/man/position_quasirandom.Rd b/man/position_quasirandom.Rd
@@ -25,14 +25,14 @@ Smaller numbers (< 1) produce a tighter "fit". (default: 0.5)}
 Violin point-style plots to show overlapping points. x must be discrete.
 }
 \examples{
-ggplot2::qplot(class, hwy, data = ggplot2::mpg, position=position_quasirandom())
+ggplot2::qplot(class, hwy, data = ggplot2::mpg, geom='quasirandom')
   # Generate fake data
   distro <- data.frame(
     'variable'=rep(c('runif','rnorm'),each=100),
     'value'=c(runif(100, min=-3, max=3), rnorm(100))
   )
-  ggplot2::qplot(variable, value, data = distro, position = position_quasirandom())
-  ggplot2::qplot(variable, value, data = distro, position = position_quasirandom(width=0.1))
+  ggplot2::qplot(variable, value, data = distro, geom = 'quasirandom')
+  ggplot2::qplot(variable, value, data = distro) + geom_quasirandom(width=0.1)
 }
 \seealso{
 \code{\link[vipor]{offsetX}}