## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## glue 1.4.1 2020-05-13 [2] CRAN (R 4.0.0)
## gtable 0.3.0 2019-03-25 [2] CRAN (R 4.0.0)
@@ -317,13 +317,13 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
## RColorBrewer 1.1-2 2014-12-07 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -331,7 +331,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -339,7 +339,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/articles/labels.html b/docs/articles/labels.html
index faf44b69..6ed4fde4 100644
--- a/docs/articles/labels.html
+++ b/docs/articles/labels.html
@@ -91,7 +91,7 @@
Labeling small strata
Jason Cory Brunson
- 2020-07-05
+ 2020-07-14
Source: vignettes/labels.rmd
labels.rmd
@@ -214,12 +214,17 @@
## f(..., self = self)
##
## <Inner function (f)>
-## function (self, data, scales, decreasing = ggalluvial_opt("decreasing"),
-## reverse = ggalluvial_opt("reverse"), absolute = ggalluvial_opt("absolute"),
-## discern = FALSE, distill = first, negate.strata = NULL, infer.label = FALSE,
-## label.strata = NULL, min.y = NULL, max.y = NULL, min.height = NULL,
-## max.height = NULL)
+## function (self, data, scales, decreasing = NULL, reverse = NULL,
+## absolute = NULL, discern = FALSE, distill = first, negate.strata = NULL,
+## infer.label = FALSE, label.strata = NULL, min.y = NULL, max.y = NULL,
+## min.height = NULL, max.height = NULL)
## {
+## if (is.null(decreasing))
+## decreasing <- ggalluvial_opt("decreasing")
+## if (is.null(reverse))
+## reverse <- ggalluvial_opt("reverse")
+## if (is.null(absolute))
+## absolute <- ggalluvial_opt("absolute")
## if (!is.null(label.strata)) {
## defunct_parameter("label.strata", msg = "use `aes(label = after_stat(stratum))`.")
## infer.label <- label.strata
@@ -355,7 +360,7 @@
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -371,9 +376,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggfittext 0.9.0 2020-06-14 [2] CRAN (R 4.0.0)
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## ggrepel 0.8.2 2020-03-08 [2] CRAN (R 4.0.0)
@@ -387,12 +392,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -400,7 +405,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -408,7 +413,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/articles/labels_files/figure-html/ggrepel-1.png b/docs/articles/labels_files/figure-html/ggrepel-1.png
index 118701c0..fe09df7a 100644
Binary files a/docs/articles/labels_files/figure-html/ggrepel-1.png and b/docs/articles/labels_files/figure-html/ggrepel-1.png differ
diff --git a/docs/articles/order-rectangles.html b/docs/articles/order-rectangles.html
index 20d14c9a..a80d9aa1 100644
--- a/docs/articles/order-rectangles.html
+++ b/docs/articles/order-rectangles.html
@@ -91,7 +91,7 @@
The Order of the Rectangles
Jason Cory Brunson
- 2020-07-05
+ 2020-07-14
Source: vignettes/order-rectangles.rmd
order-rectangles.rmd
@@ -484,7 +484,7 @@
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -500,9 +500,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## glue 1.4.1 2020-05-13 [2] CRAN (R 4.0.0)
## gtable 0.3.0 2019-03-25 [2] CRAN (R 4.0.0)
@@ -514,12 +514,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -527,7 +527,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -535,7 +535,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/news/index.html b/docs/news/index.html
index 0ccbdee8..6fafa88b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -183,7 +183,12 @@
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
-These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+
+
+
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 7bde393e..78cd555b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
ggalluvial: ggalluvial.html
labels: labels.html
order-rectangles: order-rectangles.html
-last_built: 2020-07-05T23:34Z
+last_built: 2020-07-14T12:00Z
diff --git a/docs/reference/geom_alluvium-1.png b/docs/reference/geom_alluvium-1.png
index 88845765..4eaae8e3 100644
Binary files a/docs/reference/geom_alluvium-1.png and b/docs/reference/geom_alluvium-1.png differ
diff --git a/docs/reference/geom_alluvium-2.png b/docs/reference/geom_alluvium-2.png
index 6d93c3fd..c8629cf2 100644
Binary files a/docs/reference/geom_alluvium-2.png and b/docs/reference/geom_alluvium-2.png differ
diff --git a/docs/reference/geom_alluvium-3.png b/docs/reference/geom_alluvium-3.png
index 29faa948..f97a24e7 100644
Binary files a/docs/reference/geom_alluvium-3.png and b/docs/reference/geom_alluvium-3.png differ
diff --git a/docs/reference/geom_alluvium-4.png b/docs/reference/geom_alluvium-4.png
index 51cc6a45..1c31a62f 100644
Binary files a/docs/reference/geom_alluvium-4.png and b/docs/reference/geom_alluvium-4.png differ
diff --git a/docs/reference/geom_alluvium-5.png b/docs/reference/geom_alluvium-5.png
index fa1c58b9..ac00b980 100644
Binary files a/docs/reference/geom_alluvium-5.png and b/docs/reference/geom_alluvium-5.png differ
diff --git a/docs/reference/geom_alluvium-6.png b/docs/reference/geom_alluvium-6.png
index e9ae4a7f..fb55a371 100644
Binary files a/docs/reference/geom_alluvium-6.png and b/docs/reference/geom_alluvium-6.png differ
diff --git a/docs/reference/geom_alluvium-7.png b/docs/reference/geom_alluvium-7.png
index 0cc20c13..ba4a99a2 100644
Binary files a/docs/reference/geom_alluvium-7.png and b/docs/reference/geom_alluvium-7.png differ
diff --git a/docs/reference/geom_alluvium.html b/docs/reference/geom_alluvium.html
index bc8b95c7..ac950783 100644
--- a/docs/reference/geom_alluvium.html
+++ b/docs/reference/geom_alluvium.html
@@ -154,8 +154,8 @@ Alluvia across strata
width = 1/3,
knot.pos = 1/4,
knot.prop = TRUE,
- curve = "xspline",
- reach = NULL,
+ curve_type = NULL,
+ curve_range = NULL,
segments = NULL,
na.rm = FALSE,
show.legend = NA,
@@ -215,20 +215,20 @@ Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")
# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))
# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -339,7 +339,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/articles/labels.html b/docs/articles/labels.html
index faf44b69..6ed4fde4 100644
--- a/docs/articles/labels.html
+++ b/docs/articles/labels.html
@@ -91,7 +91,7 @@
Labeling small strata
Jason Cory Brunson
- 2020-07-05
+ 2020-07-14
Source: vignettes/labels.rmd
labels.rmd
@@ -214,12 +214,17 @@
## f(..., self = self)
##
## <Inner function (f)>
-## function (self, data, scales, decreasing = ggalluvial_opt("decreasing"),
-## reverse = ggalluvial_opt("reverse"), absolute = ggalluvial_opt("absolute"),
-## discern = FALSE, distill = first, negate.strata = NULL, infer.label = FALSE,
-## label.strata = NULL, min.y = NULL, max.y = NULL, min.height = NULL,
-## max.height = NULL)
+## function (self, data, scales, decreasing = NULL, reverse = NULL,
+## absolute = NULL, discern = FALSE, distill = first, negate.strata = NULL,
+## infer.label = FALSE, label.strata = NULL, min.y = NULL, max.y = NULL,
+## min.height = NULL, max.height = NULL)
## {
+## if (is.null(decreasing))
+## decreasing <- ggalluvial_opt("decreasing")
+## if (is.null(reverse))
+## reverse <- ggalluvial_opt("reverse")
+## if (is.null(absolute))
+## absolute <- ggalluvial_opt("absolute")
## if (!is.null(label.strata)) {
## defunct_parameter("label.strata", msg = "use `aes(label = after_stat(stratum))`.")
## infer.label <- label.strata
@@ -355,7 +360,7 @@
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -371,9 +376,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggfittext 0.9.0 2020-06-14 [2] CRAN (R 4.0.0)
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## ggrepel 0.8.2 2020-03-08 [2] CRAN (R 4.0.0)
@@ -387,12 +392,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -400,7 +405,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -408,7 +413,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/articles/labels_files/figure-html/ggrepel-1.png b/docs/articles/labels_files/figure-html/ggrepel-1.png
index 118701c0..fe09df7a 100644
Binary files a/docs/articles/labels_files/figure-html/ggrepel-1.png and b/docs/articles/labels_files/figure-html/ggrepel-1.png differ
diff --git a/docs/articles/order-rectangles.html b/docs/articles/order-rectangles.html
index 20d14c9a..a80d9aa1 100644
--- a/docs/articles/order-rectangles.html
+++ b/docs/articles/order-rectangles.html
@@ -91,7 +91,7 @@
The Order of the Rectangles
Jason Cory Brunson
- 2020-07-05
+ 2020-07-14
Source: vignettes/order-rectangles.rmd
order-rectangles.rmd
@@ -484,7 +484,7 @@
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -500,9 +500,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## glue 1.4.1 2020-05-13 [2] CRAN (R 4.0.0)
## gtable 0.3.0 2019-03-25 [2] CRAN (R 4.0.0)
@@ -514,12 +514,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -527,7 +527,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -535,7 +535,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/news/index.html b/docs/news/index.html
index 0ccbdee8..6fafa88b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -183,7 +183,12 @@
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
-These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+
+
+
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 7bde393e..78cd555b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
ggalluvial: ggalluvial.html
labels: labels.html
order-rectangles: order-rectangles.html
-last_built: 2020-07-05T23:34Z
+last_built: 2020-07-14T12:00Z
diff --git a/docs/reference/geom_alluvium-1.png b/docs/reference/geom_alluvium-1.png
index 88845765..4eaae8e3 100644
Binary files a/docs/reference/geom_alluvium-1.png and b/docs/reference/geom_alluvium-1.png differ
diff --git a/docs/reference/geom_alluvium-2.png b/docs/reference/geom_alluvium-2.png
index 6d93c3fd..c8629cf2 100644
Binary files a/docs/reference/geom_alluvium-2.png and b/docs/reference/geom_alluvium-2.png differ
diff --git a/docs/reference/geom_alluvium-3.png b/docs/reference/geom_alluvium-3.png
index 29faa948..f97a24e7 100644
Binary files a/docs/reference/geom_alluvium-3.png and b/docs/reference/geom_alluvium-3.png differ
diff --git a/docs/reference/geom_alluvium-4.png b/docs/reference/geom_alluvium-4.png
index 51cc6a45..1c31a62f 100644
Binary files a/docs/reference/geom_alluvium-4.png and b/docs/reference/geom_alluvium-4.png differ
diff --git a/docs/reference/geom_alluvium-5.png b/docs/reference/geom_alluvium-5.png
index fa1c58b9..ac00b980 100644
Binary files a/docs/reference/geom_alluvium-5.png and b/docs/reference/geom_alluvium-5.png differ
diff --git a/docs/reference/geom_alluvium-6.png b/docs/reference/geom_alluvium-6.png
index e9ae4a7f..fb55a371 100644
Binary files a/docs/reference/geom_alluvium-6.png and b/docs/reference/geom_alluvium-6.png differ
diff --git a/docs/reference/geom_alluvium-7.png b/docs/reference/geom_alluvium-7.png
index 0cc20c13..ba4a99a2 100644
Binary files a/docs/reference/geom_alluvium-7.png and b/docs/reference/geom_alluvium-7.png differ
diff --git a/docs/reference/geom_alluvium.html b/docs/reference/geom_alluvium.html
index bc8b95c7..ac950783 100644
--- a/docs/reference/geom_alluvium.html
+++ b/docs/reference/geom_alluvium.html
@@ -154,8 +154,8 @@ Alluvia across strata
width = 1/3,
knot.pos = 1/4,
knot.prop = TRUE,
- curve = "xspline",
- reach = NULL,
+ curve_type = NULL,
+ curve_range = NULL,
segments = NULL,
na.rm = FALSE,
show.legend = NA,
@@ -215,20 +215,20 @@ Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Labeling small strata
Jason Cory Brunson
-2020-07-05
+2020-07-14
Source:vignettes/labels.rmd
labels.rmd
## f(..., self = self)
##
## <Inner function (f)>
-## function (self, data, scales, decreasing = ggalluvial_opt("decreasing"),
-## reverse = ggalluvial_opt("reverse"), absolute = ggalluvial_opt("absolute"),
-## discern = FALSE, distill = first, negate.strata = NULL, infer.label = FALSE,
-## label.strata = NULL, min.y = NULL, max.y = NULL, min.height = NULL,
-## max.height = NULL)
+## function (self, data, scales, decreasing = NULL, reverse = NULL,
+## absolute = NULL, discern = FALSE, distill = first, negate.strata = NULL,
+## infer.label = FALSE, label.strata = NULL, min.y = NULL, max.y = NULL,
+## min.height = NULL, max.height = NULL)
## {
+## if (is.null(decreasing))
+## decreasing <- ggalluvial_opt("decreasing")
+## if (is.null(reverse))
+## reverse <- ggalluvial_opt("reverse")
+## if (is.null(absolute))
+## absolute <- ggalluvial_opt("absolute")
## if (!is.null(label.strata)) {
## defunct_parameter("label.strata", msg = "use `aes(label = after_stat(stratum))`.")
## infer.label <- label.strata
@@ -355,7 +360,7 @@
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -371,9 +376,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggfittext 0.9.0 2020-06-14 [2] CRAN (R 4.0.0)
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## ggrepel 0.8.2 2020-03-08 [2] CRAN (R 4.0.0)
@@ -387,12 +392,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -400,7 +405,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -408,7 +413,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggfittext 0.9.0 2020-06-14 [2] CRAN (R 4.0.0)
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## ggrepel 0.8.2 2020-03-08 [2] CRAN (R 4.0.0)
@@ -387,12 +392,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -400,7 +405,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -408,7 +413,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -408,7 +413,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
The Order of the Rectangles
Jason Cory Brunson
-2020-07-05
+2020-07-14
Source:vignettes/order-rectangles.rmd
order-rectangles.rmd
## collate en_US.UTF-8
## ctype en_US.UTF-8
## tz America/New_York
-## date 2020-07-05
+## date 2020-07-14
##
## ─ Packages ───────────────────────────────────────────────────────────────────
## package * version date lib source
@@ -500,9 +500,9 @@
## evaluate 0.14 2019-05-28 [2] CRAN (R 4.0.0)
## fansi 0.4.1 2020-01-08 [2] CRAN (R 4.0.0)
## farver 2.0.3 2020-01-16 [2] CRAN (R 4.0.0)
-## fs 1.4.1 2020-04-04 [2] CRAN (R 4.0.0)
+## fs 1.4.2 2020-06-30 [2] CRAN (R 4.0.0)
## generics 0.0.2 2018-11-29 [2] CRAN (R 4.0.0)
-## ggalluvial * 0.12.0 2020-07-05 [1] local
+## ggalluvial * 0.12.0 2020-07-14 [1] local
## ggplot2 * 3.3.2 2020-06-19 [2] CRAN (R 4.0.0)
## glue 1.4.1 2020-05-13 [2] CRAN (R 4.0.0)
## gtable 0.3.0 2019-03-25 [2] CRAN (R 4.0.0)
@@ -514,12 +514,12 @@
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -527,7 +527,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -535,7 +535,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/news/index.html b/docs/news/index.html
index 0ccbdee8..6fafa88b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -183,7 +183,12 @@
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
-These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+
+
+
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 7bde393e..78cd555b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
ggalluvial: ggalluvial.html
labels: labels.html
order-rectangles: order-rectangles.html
-last_built: 2020-07-05T23:34Z
+last_built: 2020-07-14T12:00Z
diff --git a/docs/reference/geom_alluvium-1.png b/docs/reference/geom_alluvium-1.png
index 88845765..4eaae8e3 100644
Binary files a/docs/reference/geom_alluvium-1.png and b/docs/reference/geom_alluvium-1.png differ
diff --git a/docs/reference/geom_alluvium-2.png b/docs/reference/geom_alluvium-2.png
index 6d93c3fd..c8629cf2 100644
Binary files a/docs/reference/geom_alluvium-2.png and b/docs/reference/geom_alluvium-2.png differ
diff --git a/docs/reference/geom_alluvium-3.png b/docs/reference/geom_alluvium-3.png
index 29faa948..f97a24e7 100644
Binary files a/docs/reference/geom_alluvium-3.png and b/docs/reference/geom_alluvium-3.png differ
diff --git a/docs/reference/geom_alluvium-4.png b/docs/reference/geom_alluvium-4.png
index 51cc6a45..1c31a62f 100644
Binary files a/docs/reference/geom_alluvium-4.png and b/docs/reference/geom_alluvium-4.png differ
diff --git a/docs/reference/geom_alluvium-5.png b/docs/reference/geom_alluvium-5.png
index fa1c58b9..ac00b980 100644
Binary files a/docs/reference/geom_alluvium-5.png and b/docs/reference/geom_alluvium-5.png differ
diff --git a/docs/reference/geom_alluvium-6.png b/docs/reference/geom_alluvium-6.png
index e9ae4a7f..fb55a371 100644
Binary files a/docs/reference/geom_alluvium-6.png and b/docs/reference/geom_alluvium-6.png differ
diff --git a/docs/reference/geom_alluvium-7.png b/docs/reference/geom_alluvium-7.png
index 0cc20c13..ba4a99a2 100644
Binary files a/docs/reference/geom_alluvium-7.png and b/docs/reference/geom_alluvium-7.png differ
diff --git a/docs/reference/geom_alluvium.html b/docs/reference/geom_alluvium.html
index bc8b95c7..ac950783 100644
--- a/docs/reference/geom_alluvium.html
+++ b/docs/reference/geom_alluvium.html
@@ -154,8 +154,8 @@ Alluvia across strata
width = 1/3,
knot.pos = 1/4,
knot.prop = TRUE,
- curve = "xspline",
- reach = NULL,
+ curve_type = NULL,
+ curve_range = NULL,
segments = NULL,
na.rm = FALSE,
show.legend = NA,
@@ -215,20 +215,20 @@ Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
## MASS 7.3-51.5 2019-12-20 [2] CRAN (R 4.0.0)
## memoise 1.1.0 2017-04-21 [2] CRAN (R 4.0.0)
## munsell 0.5.0 2018-06-12 [2] CRAN (R 4.0.0)
-## pillar 1.4.4 2020-05-05 [2] CRAN (R 4.0.0)
+## pillar 1.4.5 2020-07-09 [2] CRAN (R 4.0.0)
## pkgconfig 2.0.3 2019-09-22 [2] CRAN (R 4.0.0)
## pkgdown 1.5.1 2020-04-09 [2] CRAN (R 4.0.0)
## purrr 0.3.4 2020-04-17 [2] CRAN (R 4.0.0)
## R6 2.4.1 2019-11-12 [2] CRAN (R 4.0.0)
-## Rcpp 1.0.4.6 2020-04-09 [2] CRAN (R 4.0.0)
+## Rcpp 1.0.5 2020-07-06 [2] CRAN (R 4.0.0)
## rlang 0.4.6 2020-05-02 [2] CRAN (R 4.0.0)
## rmarkdown 2.3 2020-06-18 [2] CRAN (R 4.0.0)
## rprojroot 1.3-2 2018-01-03 [2] CRAN (R 4.0.0)
@@ -527,7 +527,7 @@
## sessioninfo 1.1.1 2018-11-05 [2] CRAN (R 4.0.0)
## stringi 1.4.6 2020-02-17 [2] CRAN (R 4.0.0)
## stringr 1.4.0 2019-02-10 [2] CRAN (R 4.0.0)
-## tibble 3.0.1 2020-04-20 [2] CRAN (R 4.0.0)
+## tibble 3.0.2 2020-07-07 [2] CRAN (R 4.0.0)
## tidyr 1.1.0 2020-05-20 [2] CRAN (R 4.0.0)
## tidyselect 1.1.0 2020-05-11 [2] CRAN (R 4.0.0)
## vctrs 0.3.1 2020-06-05 [2] CRAN (R 4.0.0)
@@ -535,7 +535,7 @@
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/news/index.html b/docs/news/index.html
index 0ccbdee8..6fafa88b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -183,7 +183,12 @@
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
-These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+
+
+
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 7bde393e..78cd555b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
ggalluvial: ggalluvial.html
labels: labels.html
order-rectangles: order-rectangles.html
-last_built: 2020-07-05T23:34Z
+last_built: 2020-07-14T12:00Z
diff --git a/docs/reference/geom_alluvium-1.png b/docs/reference/geom_alluvium-1.png
index 88845765..4eaae8e3 100644
Binary files a/docs/reference/geom_alluvium-1.png and b/docs/reference/geom_alluvium-1.png differ
diff --git a/docs/reference/geom_alluvium-2.png b/docs/reference/geom_alluvium-2.png
index 6d93c3fd..c8629cf2 100644
Binary files a/docs/reference/geom_alluvium-2.png and b/docs/reference/geom_alluvium-2.png differ
diff --git a/docs/reference/geom_alluvium-3.png b/docs/reference/geom_alluvium-3.png
index 29faa948..f97a24e7 100644
Binary files a/docs/reference/geom_alluvium-3.png and b/docs/reference/geom_alluvium-3.png differ
diff --git a/docs/reference/geom_alluvium-4.png b/docs/reference/geom_alluvium-4.png
index 51cc6a45..1c31a62f 100644
Binary files a/docs/reference/geom_alluvium-4.png and b/docs/reference/geom_alluvium-4.png differ
diff --git a/docs/reference/geom_alluvium-5.png b/docs/reference/geom_alluvium-5.png
index fa1c58b9..ac00b980 100644
Binary files a/docs/reference/geom_alluvium-5.png and b/docs/reference/geom_alluvium-5.png differ
diff --git a/docs/reference/geom_alluvium-6.png b/docs/reference/geom_alluvium-6.png
index e9ae4a7f..fb55a371 100644
Binary files a/docs/reference/geom_alluvium-6.png and b/docs/reference/geom_alluvium-6.png differ
diff --git a/docs/reference/geom_alluvium-7.png b/docs/reference/geom_alluvium-7.png
index 0cc20c13..ba4a99a2 100644
Binary files a/docs/reference/geom_alluvium-7.png and b/docs/reference/geom_alluvium-7.png differ
diff --git a/docs/reference/geom_alluvium.html b/docs/reference/geom_alluvium.html
index bc8b95c7..ac950783 100644
--- a/docs/reference/geom_alluvium.html
+++ b/docs/reference/geom_alluvium.html
@@ -154,8 +154,8 @@ Alluvia across strata
width = 1/3,
knot.pos = 1/4,
knot.prop = TRUE,
- curve = "xspline",
- reach = NULL,
+ curve_type = NULL,
+ curve_range = NULL,
segments = NULL,
na.rm = FALSE,
show.legend = NA,
@@ -215,20 +215,20 @@ Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
## xfun 0.15 2020-06-21 [2] CRAN (R 4.0.0)
## yaml 2.2.1 2020-02-01 [2] CRAN (R 4.0.0)
##
-## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmppYMemk/temp_libpath96d813c91061
+## [1] /private/var/folders/pg/fjg8r4fj5v33zqmwptf9mfg80000gn/T/RtmpB1mfo4/temp_libpath85925d7eb318
## [2] /Library/Frameworks/R.framework/Versions/4.0/Resources/library
diff --git a/docs/news/index.html b/docs/news/index.html
index 0ccbdee8..6fafa88b 100644
--- a/docs/news/index.html
+++ b/docs/news/index.html
@@ -183,7 +183,12 @@
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
-These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+
+
+
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 7bde393e..78cd555b 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -5,5 +5,5 @@ articles:
ggalluvial: ggalluvial.html
labels: labels.html
order-rectangles: order-rectangles.html
-last_built: 2020-07-05T23:34Z
+last_built: 2020-07-14T12:00Z
diff --git a/docs/reference/geom_alluvium-1.png b/docs/reference/geom_alluvium-1.png
index 88845765..4eaae8e3 100644
Binary files a/docs/reference/geom_alluvium-1.png and b/docs/reference/geom_alluvium-1.png differ
diff --git a/docs/reference/geom_alluvium-2.png b/docs/reference/geom_alluvium-2.png
index 6d93c3fd..c8629cf2 100644
Binary files a/docs/reference/geom_alluvium-2.png and b/docs/reference/geom_alluvium-2.png differ
diff --git a/docs/reference/geom_alluvium-3.png b/docs/reference/geom_alluvium-3.png
index 29faa948..f97a24e7 100644
Binary files a/docs/reference/geom_alluvium-3.png and b/docs/reference/geom_alluvium-3.png differ
diff --git a/docs/reference/geom_alluvium-4.png b/docs/reference/geom_alluvium-4.png
index 51cc6a45..1c31a62f 100644
Binary files a/docs/reference/geom_alluvium-4.png and b/docs/reference/geom_alluvium-4.png differ
diff --git a/docs/reference/geom_alluvium-5.png b/docs/reference/geom_alluvium-5.png
index fa1c58b9..ac00b980 100644
Binary files a/docs/reference/geom_alluvium-5.png and b/docs/reference/geom_alluvium-5.png differ
diff --git a/docs/reference/geom_alluvium-6.png b/docs/reference/geom_alluvium-6.png
index e9ae4a7f..fb55a371 100644
Binary files a/docs/reference/geom_alluvium-6.png and b/docs/reference/geom_alluvium-6.png differ
diff --git a/docs/reference/geom_alluvium-7.png b/docs/reference/geom_alluvium-7.png
index 0cc20c13..ba4a99a2 100644
Binary files a/docs/reference/geom_alluvium-7.png and b/docs/reference/geom_alluvium-7.png differ
diff --git a/docs/reference/geom_alluvium.html b/docs/reference/geom_alluvium.html
index bc8b95c7..ac950783 100644
--- a/docs/reference/geom_alluvium.html
+++ b/docs/reference/geom_alluvium.html
@@ -154,8 +154,8 @@ Alluvia across strata
width = 1/3,
knot.pos = 1/4,
knot.prop = TRUE,
- curve = "xspline",
- reach = NULL,
+ curve_type = NULL,
+ curve_range = NULL,
segments = NULL,
na.rm = FALSE,
show.legend = NA,
@@ -215,20 +215,20 @@ Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow upgrades and extensions
The knot.pos parameter of geom_alluvium() and geom_flow() is now interpreted as a proportion of the total length of each flow, i.e. of the gap between adjacent strata (not axes). This means that values will vary with axis positions and stratum widths. Setting the new knot.prop parameter to FALSE prevents this by interpreting knot.pos as a constant value in the x direction.
These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new reach parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
These flows are rendered using grid::xsplineGrob() with four control points each: the endpoints and the two knots. To complement them, several other curves are now available: linear (equivalent to knot.pos = 0), cubic, quintic, sinusoidal, arctangent, and sigmoid, summoned by the new curve_type parameter (which defaults to the x-spline). (The asymptotic functions, arctangent and sigmoid, are compressed according to the new curve_range parameter.) The new curves are rendered piecewise linearly, with resolution controlled by the new segments parameter (similar to ggplot2::stat_ellipse()).
+Options
+The stratum and lode ordering parameters now default to NULL, in which case they are reassigned to global options internally. This simplifies their documentation. The new curve parameters curve_type, curve_range, and segments can also be set as options and are documented in the same way.
Alluvia across strata
width = 1/3, knot.pos = 1/4, knot.prop = TRUE, - curve = "xspline", - reach = NULL, + curve_type = NULL, + curve_range = NULL, segments = NULL, na.rm = FALSE, show.legend = NA, @@ -215,20 +215,20 @@Arg
the length of each flow (the default), rather than on the x scale.
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -288,18 +288,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -310,16 +310,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@ Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
- curve
- Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
curve_type
+ Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
- reach
- For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
curve_range
+ For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
segments
@@ -298,18 +298,18 @@ CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
+filled regions between parallel x-splines. These graphical elements,
+generated using grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes
0 to 0 and 1 to 1
"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique
@@ -320,16 +320,29 @@
Curves
"sine": the unique sinusoidal function that is flat at both
endpoints
"arctangent": the inverse tangent function, scaled and re-centered to the
-unit interval from a symmetric domain with radius reach
curve_range
"sigmoid": the sigmoid function, scaled and re-centered to the unit
-interval from a symmetric domain with radius reach
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
+ggalluvial.curve_type: defaults to "xspline".
ggalluvial.curve_range: defaults to NA, which triggers the
+curve-specific default values.
ggalluvial.segments: defaults to 48L.
+
+See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@ Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
-
+filled regions between parallel x-splines. These graphical elements,
+generated using
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes 0 to 0 and 1 to 1"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique @@ -310,16 +310,29 @@Curves
"sine": the unique sinusoidal function that is flat at both endpoints"arctangent": the inverse tangent function, scaled and re-centered to the -unit interval from a symmetric domain with radiusreach
+unit interval from the interval centered at zero with
+radius "sigmoid": the sigmoid function, scaled and re-centered to the unit -interval from a symmetric domain with radiusreach
+interval from the interval centered at zero with radius
+ggalluvial.curve_type: defaults to"xspline".
+ggalluvial.curve_range: defaults toNA, which triggers the +curve-specific default values.
+ggalluvial.segments: defaults to48L.
+
grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
curve_range
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
-
+
See base::options() for how to use options.
Defunct parameters
@@ -349,7 +362,7 @@Examp
# time series bump chart (quintic flows)
gg + geom_alluvium(aes(fill = country, colour = country),
width = 1/4, alpha = 2/3, decreasing = FALSE,
- curve = "quintic")# time series line plot of refugees data, sorted by country
+ curve_type = "sigmoid")# time series line plot of refugees data, sorted by country
gg + geom_alluvium(aes(fill = country, colour = country),
decreasing = NA, width = 0, knot.pos = 0)
# irregular spacing between axes of a continuous variable
@@ -371,8 +384,13 @@ Examp
gg +
geom_alluvium(aes(fill = country),
alpha = .75, decreasing = FALSE, width = 1/2,
- curve = "arctan", segments = 6) +
- geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
+ curve_type = "arctan", segments = 6) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)# custom-ranged curves
+gg +
+ geom_alluvium(aes(fill = country),
+ alpha = .75, decreasing = FALSE, width = 1/2,
+ curve_type = "arctan", curve_range = 1) +
+ geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
Examp gg + geom_alluvium(aes(fill = country), alpha = .75, decreasing = FALSE, width = 1/2, - curve = "arctan", segments = 6) + - geom_stratum(aes(stratum = country), decreasing = FALSE, width = 1/2)
Character; the type of curve used to produce flows. Defaults to
-"xspline" and can be alternatively set to one of "linear", "cubic",
-"quintic", "sine", "arctangent", and "sigmoid". "xspline"
-produces approximation splines using 4 points per curve; the alternatives
-produce interpolation splines between points along the graphs of functions
-of the associated type. See the Curves section.
Character; the type of curve used to produce flows.
+Defaults to "xspline" and can be alternatively set to one of "linear",
+"cubic", "quintic", "sine", "arctangent", and "sigmoid".
+"xspline" produces approximation splines using 4 points per curve; the
+alternatives produce interpolation splines between points along the graphs
+of functions of the associated type. See the Curves section.
For alternative curves based on asymptotic functions, the
-value along the asymptote at which to truncate the function to obtain the
-shape that will be scaled to fit between strata. See the Curves
-section.
For alternative curve_types based on asymptotic
+functions, the value along the asymptote at which to truncate the function
+to obtain the shape that will be scaled to fit between strata. See the
+Curves section.
CurvesBy default, geom_alluvium() and geom_flow() render flows between lodes as
-splines about quartets of control points using grid::xsplineGrob(). These
-curves are parameterized by the relative location of the knot (knot.pos)
-that governs the bending of each end toward their meeting at the point of
-inflection. They are quick to render and clear to read. Nevertheless, for any
-number of reasons, users may prefer plots that use differently-shaped curves.
-
A variety of such options are illustrated in this blog post by Jeffrey Shaffer. A subset of these,
-some with added flexibility, are implemented here. Each is encoded as a
-continuous, increasing, bijective function from the unit interval \([0,1]\)
-to itself, and each is rescaled, if necessary, so that its endpoints meet the
-corresponding lodes. They are rendered piecewise-linearly, by default using
-segments = 48. Summon each curve type by passing one of the following
-strings to curve:
-
+filled regions between parallel x-splines. These graphical elements,
+generated using
"linear": \(f(x)=x\), the unique degree-1 polynomial that takes 0 to 0 and 1 to 1"cubic": \(f(x)=3x^{2}-2x^{3}\), the unique @@ -320,16 +320,29 @@Curves
"sine": the unique sinusoidal function that is flat at both endpoints"arctangent": the inverse tangent function, scaled and re-centered to the -unit interval from a symmetric domain with radiusreach
+unit interval from the interval centered at zero with
+radius "sigmoid": the sigmoid function, scaled and re-centered to the unit -interval from a symmetric domain with radiusreach
+interval from the interval centered at zero with radius
+ggalluvial.curve_type: defaults to"xspline".
+ggalluvial.curve_range: defaults toNA, which triggers the +curve-specific default values.
+ggalluvial.segments: defaults to48L.
+nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
diff --git a/docs/reference/stat_flow.html b/docs/reference/stat_flow.html
index 02b42b14..cc71971e 100644
--- a/docs/reference/stat_flow.html
+++ b/docs/reference/stat_flow.html
@@ -147,12 +147,12 @@ nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
diff --git a/docs/reference/stat_stratum.html b/docs/reference/stat_stratum.html
index 5a4065be..4fcd2dad 100644
--- a/docs/reference/stat_stratum.html
+++ b/docs/reference/stat_stratum.html
@@ -147,9 +147,9 @@ nnumber of cases in lode
countcumulative weight of lode
propweighted proportion of lode
grid::xsplineGrob(), are
+parameterized by the relative location of the knot (knot.pos). They are
+quick to render and clear to read, but users may prefer plots that use
+differently-shaped ribbons.
+A variety of such options are documented at, e.g., this easing functions cheat sheet and this blog post by Jeffrey Shaffer. Easing functions are
+not (yet) used in ggalluvial, but several alternative curves are available.
+Each is encoded as a continuous, increasing, bijective function from the unit
+interval \([0,1]\) to itself, and each is rescaled so that its endpoints
+meet the corresponding lodes. They are rendered piecewise-linearly, by
+default using segments = 48. Summon each curve type by passing one of the
+following strings to curve_type:
curve_range
curve_range
Only the (default) "xspline" option uses the knot.* parameters, while
only the alternative curves use the segments parameter, and only
-"arctangent" and "sigmoid" use the reach parameter. Larger values of
-reach result in greater compression and steeper slopes. The NULL default
-will be changed to 2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
"arctangent" and "sigmoid" use the curve_range parameter. (Both are
+ignored if not needed.) Larger values of curve_range result in greater
+compression and steeper slopes. The NULL default will be changed to
+2+sqrt(3) for "arctangent" and to 6 for "sigmoid".
+These package-specific options set global values for curve_type,
+curve_range, and segments that will be defaulted to when not manually
+set:
-
+
See base::options() for how to use options.
Defunct parameters
@@ -360,7 +373,7 @@Examp
ggplot(as.data.frame(Titanic),
aes(y = Freq,
axis1 = Class, axis2 = Sex)) +
- geom_flow(aes(fill = Age), width = .4, curve = "sigmoid") +
+ geom_flow(aes(fill = Age), width = .4, curve_type = "quintic") +
geom_stratum(width = .4) +
geom_text(stat = "stratum", aes(label = after_stat(stratum)), size = 3) +
scale_x_discrete(limits = c("Class", "Sex")) +
@@ -385,13 +398,13 @@ Examp
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
y = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "stratum", aes(label = round(after_stat(prop), 3)))# annotate fixed-width ribbons with counts
ggplot(vaccinations,
aes(x = survey, stratum = response, alluvium = subject,
weight = freq, fill = response)) +
- geom_lode() + geom_flow(curve = "cubic") +
+ geom_lode() + geom_flow(curve_type = "cubic") +
geom_stratum(alpha = 0) +
geom_text(stat = "flow",
aes(label = after_stat(n),
diff --git a/docs/reference/self-adjoin.html b/docs/reference/self-adjoin.html
index fc2fc83f..e0b735e6 100644
--- a/docs/reference/self-adjoin.html
+++ b/docs/reference/self-adjoin.html
@@ -168,7 +168,7 @@ Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Arg
by
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
link
@@ -185,13 +185,13 @@ Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
diff --git a/docs/reference/stat_alluvium.html b/docs/reference/stat_alluvium.html
index c01f98d4..ff2401e6 100644
--- a/docs/reference/stat_alluvium.html
+++ b/docs/reference/stat_alluvium.html
@@ -149,16 +149,16 @@ Alluvial positions
data = NULL,
geom = "alluvium",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
aggregate.y = NULL,
- cement.alluvia = ggalluvial_opt("cement.alluvia"),
- lode.guidance = ggalluvial_opt("lode.guidance"),
+ cement.alluvia = NULL,
+ lode.guidance = NULL,
lode.ordering = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -284,8 +284,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -368,9 +368,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Flow positions
data = NULL,
geom = "flow",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
negate.strata = NULL,
- aes.bind = ggalluvial_opt("aes.bind"),
+ aes.bind = NULL,
infer.label = FALSE,
min.y = NULL,
max.y = NULL,
@@ -250,8 +250,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
min.y
@@ -334,9 +334,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Stratum positions
data = NULL,
geom = "stratum",
position = "identity",
- decreasing = ggalluvial_opt("decreasing"),
- reverse = ggalluvial_opt("reverse"),
- absolute = ggalluvial_opt("absolute"),
+ decreasing = NULL,
+ reverse = NULL,
+ absolute = NULL,
discern = FALSE,
distill = first,
negate.strata = NULL,
@@ -229,10 +229,11 @@ Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Character vector of variables to self-adjoin by; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Arg
suffix
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
Details
-
Suffixes to add to the adjoined link variables; passed to
-dplyr::join functions.
dplyr::mutate-joins functions.
self_adjoin invokes dplyr::join functions in order to convert
+
self_adjoin invokes dplyr::mutate-joins functions in order to convert
a dataset with measures along a discrete key variable into a dataset
consisting of column bindings of these measures (by any by variables) along
adjacent values of key.
Alluvial positions
data = NULL, geom = "alluvium", position = "identity", - decreasing = ggalluvial_opt("decreasing"), - reverse = ggalluvial_opt("reverse"), - absolute = ggalluvial_opt("absolute"), + decreasing = NULL, + reverse = NULL, + absolute = NULL, discern = FALSE, negate.strata = NULL, aggregate.y = NULL, - cement.alluvia = ggalluvial_opt("cement.alluvia"), - lode.guidance = ggalluvial_opt("lode.guidance"), + cement.alluvia = NULL, + lode.guidance = NULL, lode.ordering = NULL, - aes.bind = ggalluvial_opt("aes.bind"), + aes.bind = NULL, infer.label = FALSE, min.y = NULL, max.y = NULL, @@ -284,8 +284,8 @@Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Flow positions
data = NULL, geom = "flow", position = "identity", - decreasing = ggalluvial_opt("decreasing"), - reverse = ggalluvial_opt("reverse"), - absolute = ggalluvial_opt("absolute"), + decreasing = NULL, + reverse = NULL, + absolute = NULL, discern = FALSE, negate.strata = NULL, - aes.bind = ggalluvial_opt("aes.bind"), + aes.bind = NULL, infer.label = FALSE, min.y = NULL, max.y = NULL, @@ -250,8 +250,8 @@Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
Stratum positions
data = NULL, geom = "stratum", position = "identity", - decreasing = ggalluvial_opt("decreasing"), - reverse = ggalluvial_opt("reverse"), - absolute = ggalluvial_opt("absolute"), + decreasing = NULL, + reverse = NULL, + absolute = NULL, discern = FALSE, distill = first, negate.strata = NULL, @@ -229,10 +229,11 @@Arg
distill
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
negate.strata
@@ -245,8 +246,8 @@ Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
label.strata
@@ -331,9 +332,8 @@ A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
+ These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.
A function (or its name) to be used to distill alluvium values
-to a single lode label, accessible via ggplot2::after_stat() (similar to
-its behavior in to_alluvia_form()). In addition to existing functions,
-accepts the character values "first" (the default), "last", and
-"most" (which returns the first modal value).
ggplot2::after_stat() (similar to its behavior in
+to_alluvia_form()). In addition to existing functions, accepts the
+character values "first" (the default), "last", and "most" (which
+returns the first modal value).
Arg
variable to the label aesthetic. Defaults to FALSE, and requires that
no label aesthetic is assigned. This parameter is intended for use only
with data in alluva form, which are converted to lode form before the
-statistical transformation. Deprecated; use ggplot2::after_stat()
-instead.
+statistical transformation. Deprecated; use
+ggplot2::after_stat() instead.
A
observations within each (and are otherwise assigned NA).
Computed variables
-
-
-
These can be used with ggplot2::after_stat() to control aesthetic evaluation.
These can be used with
+ggplot2::after_stat() to control aesthetic evaluation.