document

Author: teunbrand

DESCRIPTION

@@ -247,6 +247,7 @@ Collate:
     'stat-bindot.R'
     'stat-binhex.R'
     'stat-boxplot.R'
+    'stat-connect.R'
     'stat-contour.R'
     'stat-count.R'
     'stat-density-2d.R'

NAMESPACE

@@ -257,6 +257,7 @@ export(StatBin2d)
 export(StatBindot)
 export(StatBinhex)
 export(StatBoxplot)
+export(StatConnect)
 export(StatContour)
 export(StatContourFilled)
 export(StatCount)
@@ -684,6 +685,7 @@ export(stat_bin_2d)
 export(stat_bin_hex)
 export(stat_binhex)
 export(stat_boxplot)
+export(stat_connect)
 export(stat_contour)
 export(stat_contour_filled)
 export(stat_count)

R/stat-connect.R

@@ -1,3 +1,37 @@
+#' Connect observations
+#'
+#' Connect successive points with lines of different shapes.
+#'
+#' @inheritParams layer
+#' @inheritParams geom_point
+#' @param connection A specification of how two points are connected. Can be one
+#'  of the folloing:
+#'  * A string giving a named connection. These options are:
+#'      * `"hv"` to first jump horizontally, then vertically.
+#'      * `"vh"` to first jump vertically, then horizontally.
+#'      * `"mid"` to step half-way between adjacent x-values.
+#'      * `"linear"` to use a straight segment.
+#'  * A numeric matrix with two columns giving x and y coordinates respectively.
+#'    The coordinates should describe points on a path that connect point A
+#'    at location (0, 0) and point B at location (1, 1). At least one of these
+#'    two points is expected to be included in the coordinates.
+#'
+#' @eval rd_aesthetics("stat", "connect")
+#' @export
+#'
+#' @examples
+#' ggplot(head(economics, 20), aes(date, unemploy)) +
+#'   stat_connect(connection = "hv")
+#'
+#' # Setup custom connections
+#' x <- seq(0, 1, length.out = 20)[-1]
+#' smooth <- cbind(x, scales::rescale(1 / (1 + exp(-(x * 10 - 5)))))
+#' zigzag <- cbind(c(0.4, 0.6, 1), c(0.75, 0.25, 1))
+#'
+#' ggplot(head(economics, 10), aes(date, unemploy)) +
+#'   geom_point() +
+#'   stat_connect(aes(colour = "zigzag"), connection = zigzag) +
+#'   stat_connect(aes(colour = "smooth"), connection = smooth)
 stat_connect <- function(
     mapping = NULL,
     data = NULL,
@@ -24,6 +58,10 @@ stat_connect <- function(
   )
 }
 
+#' @rdname ggplot2-ggproto
+#' @format NULL
+#' @usage NULL
+#' @export
 StatConnect <- ggproto(
   "StatConnect", Stat,