Skip to content

Commit 0bef4cb

Browse files
committed
wrap lines
1 parent 932e5f8 commit 0bef4cb

1 file changed

Lines changed: 98 additions & 35 deletions

File tree

NEWS.md

Lines changed: 98 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
11
# next version
22

3-
As with the `data` argument, the `referent` argument of `stat_referent()` can now be passed a function, which will be evaluated at `data` to obtain the reference data for the plot layer.
3+
As with the `data` argument, the `referent` argument of `stat_referent()` can
4+
now be passed a function, which will be evaluated at `data` to obtain the
5+
reference data for the plot layer.
46
The evaluation is done during addition of a layer of class `LayerRef`.
57

68
# gggda 0.1.1
79

8-
This patch fixes a bug in the peel stat and adds unit tests for it and the scale stat.
10+
This patch fixes a bug in the peel stat and adds unit tests for it and the scale
11+
stat.
912

10-
To resolve outstanding CRAN checks, a cross-reference to {ordr} has been replaced with a URL and {dplyr} and {tidyr} functions previously called using the double-colon operator have been imported instead.
13+
To resolve outstanding CRAN checks, a cross-reference to {ordr} has been
14+
replaced with a URL and {dplyr} and {tidyr} functions previously called using
15+
the double-colon operator have been imported instead.
1116

1217
# gggda 0.1.0
1318

14-
The inaugural version of {gggda} was spun off the post-v0.1.1 development version of {ordr}.
15-
Upgrades to {ordr} components since that release that are included in {gggda} are listed here.
19+
The inaugural version of {gggda} was spun off the post-v0.1.1 development
20+
version of {ordr}.
21+
Upgrades to {ordr} components since that release that are included in {gggda}
22+
are listed here.
1623

1724
## infrastructure and standards
1825

@@ -24,30 +31,44 @@ Unit tests have been written for all ggproto shortcuts.
2431

2532
### GDA-geared coordinate systems
2633

27-
Two new coordinate systems provide control over the aspect ratio of the plotting window without compromising that of the (artificial) coordinate axes:
28-
`GeomRect` (alias `GeomSquare`) extends `GeomFixed` with an `window_ratio` parameter for the plotting window, while `GeomBiplot` removes the `ratio` parameter and forces the coordinate axes to have aspect ratio 1.
34+
Two new coordinate systems provide control over the aspect ratio of the plotting
35+
window without compromising that of the (artificial) coordinate axes:
36+
`GeomRect` (alias `GeomSquare`) extends `GeomFixed` with an `window_ratio`
37+
parameter for the plotting window, while `GeomBiplot` removes the `ratio`
38+
parameter and forces the coordinate axes to have aspect ratio 1.
2939

3040
## up( or down)grades to existing plot layers
3141

3242
### combined vector and radiating text geom (breaking change)
3343

3444
The 'vector' and 'text_radiate' geoms have been combined.
35-
The shortcut `geom_text_radiate()` is deprecated, and `geom_vector()` generates radiating labels by default.
45+
The shortcut `geom_text_radiate()` is deprecated, and `geom_vector()` generates
46+
radiating labels by default.
3647

3748
### debugged axis geom
3849

39-
The 'axis' and 'isoline' geoms hit trouble when one or more points lay at the origin (`x^2 + y^2 == 0`). These cases have now been removed in `setup_data()`.
50+
The 'axis' and 'isoline' geoms hit trouble when one or more points lay at the
51+
origin (`x^2 + y^2 == 0`). These cases have now been removed in `setup_data()`.
4052

4153
### reconciliation of summary functions
4254

43-
The 'center' and 'star' stats now follow the 'summary' stat convention of using `fun`, so `fun.center` is deprecated.
44-
Additionally, `fun.ord` accepts a function that summarizes the columns of a matrix, which accommodates summaries like the depth median that do not decompose along orthogonal axes.
55+
The 'center' and 'star' stats now follow the 'summary' stat convention of using
56+
`fun`, so `fun.center` is deprecated.
57+
Additionally, `fun.ord` accepts a function that summarizes the columns of a
58+
matrix, which accommodates summaries like the depth median that do not decompose
59+
along orthogonal axes.
4560

4661
### revamped handling of secondary aesthetics (breaking change)
4762

48-
Previously, underscore-separated parameters like `label_colour` were used to specify secondary aesthetics, i.e. aesthetics for graphical objects other than those considered "primary" for the layer.
49-
Their behavior has been debugged by mimicking the use of period-separated parameters like `label.colour` in {ggplot2} v3.5.1, except for the new bagplot geom, for which their behavior is based on that of `geom_boxplot()` in the current development version of {ggplot2}.
50-
This induces some breaking changes due to the renaming of most, and the removal of some, such parameters.
63+
Previously, underscore-separated parameters like `label_colour` were used to
64+
specify secondary aesthetics, i.e. aesthetics for graphical objects other than
65+
those considered "primary" for the layer.
66+
Their behavior has been debugged by mimicking the use of period-separated
67+
parameters like `label.colour` in {ggplot2} v3.5.1, except for the new bagplot
68+
geom, for which their behavior is based on that of `geom_boxplot()` in the
69+
current development version of {ggplot2}.
70+
This induces some breaking changes due to the renaming of most, and the removal
71+
of some, such parameters.
5172

5273
### deprecation of scale stat
5374

@@ -57,92 +78,134 @@ The simple and experimental `StatScale` has been deprecated.
5778

5879
### referential stats
5980

60-
A new statistical transformation serves to parent specific "referential stats", meaning those that depend on non-inherited (in this setting, positional) data to transform the inherited data. The reference data are passed to the new `referent` parameter. The new stat is coupled with an additional `LayerRef` class that enables `ggplot_add()` to pass the inherited positional aesthetics to `$setup_params()`. Biplot-specific `stat_*_*()` shortcuts accept additional argument types to `referent` that result in the opposite matrix factor being used as reference data.
81+
A new statistical transformation serves to parent specific "referential stats",
82+
meaning those that depend on non-inherited (in this setting, positional) data to
83+
transform the inherited data. The reference data are passed to the new
84+
`referent` parameter. The new stat is coupled with an additional `LayerRef`
85+
class that enables `ggplot_add()` to pass the inherited positional aesthetics to
86+
`$setup_params()`. Biplot-specific `stat_*_*()` shortcuts accept additional
87+
argument types to `referent` that result in the opposite matrix factor being
88+
used as reference data.
6189

6290
### rule stat
6391

64-
A new 'rule' statistical transformation computes additional position aesthetics that the 'axis' geom uses to limit and offset axes. The stat is referential and expects a set of functions that compute limits `lower` and `upper` along the axes and `yintercept` and `xintercept` associated with offset axes. The 'axis' geom preprocesses these aesthetics to rule endpoints `xmin,ymin,xmax,ymax` and offset vectors `xend,yend` to force the plotting window to contain the limited axis segments or, if the axes remain lines, the offsets where they are centered.
92+
A new 'rule' statistical transformation computes additional position aesthetics
93+
that the 'axis' geom uses to limit and offset axes. The stat is referential and
94+
expects a set of functions that compute limits `lower` and `upper` along the
95+
axes and `yintercept` and `xintercept` associated with offset axes. The 'axis'
96+
geom preprocesses these aesthetics to rule endpoints `xmin,ymin,xmax,ymax` and
97+
offset vectors `xend,yend` to force the plotting window to contain the limited
98+
axis segments or, if the axes remain lines, the offsets where they are centered.
6599

66100
### peel stat
67101

68-
A new 'peel' statistical transformation computes nested convex hulls containing specified fractions of data.
102+
A new 'peel' statistical transformation computes nested convex hulls containing
103+
specified fractions of data.
69104

70105
### depth stat
71106

72-
A new 'depth' statistical transformation estimates depth across a grid and is paired with `GeomContour` to produce depth contours, which can be used to plot alpha bags.
107+
A new 'depth' statistical transformation estimates depth across a grid and is
108+
paired with `GeomContour` to produce depth contours, which can be used to plot
109+
alpha bags.
73110

74111
### adapted density stat & geom
75112

76-
Aided by element standardization, the classic `density_2d` statistical transformation and geometric construction are adapted to biplots.
77-
Currently, source code generation does not respect fixed parameters passed to `layer()` by the `stat_*()` and `geom_*()` shortcuts; as a consequence, `contour = TRUE` must be manually passed to `geom_*_density_2d()`.
113+
Aided by element standardization, the classic `density_2d` statistical
114+
transformation and geometric construction are adapted to biplots.
115+
Currently, source code generation does not respect fixed parameters passed to
116+
`layer()` by the `stat_*()` and `geom_*()` shortcuts; as a consequence, `contour
117+
= TRUE` must be manually passed to `geom_*_density_2d()`.
78118

79119
# ordr 0.1.1
80120

81121
## `linewidth` aesthetic (breaking change)
82122

83-
An upcoming release of {ggplot2} controls stroke width using the new `linewidth` aesthetic rather than `size`. This {ordr} release adapts to this change internally for `GeomUnitCircle` and by updating row and column layers automatically adapted from {ggplot2}. (#50)
123+
An upcoming release of {ggplot2} controls stroke width using the new `linewidth`
124+
aesthetic rather than `size`. This {ordr} release adapts to this change
125+
internally for `GeomUnitCircle` and by updating row and column layers
126+
automatically adapted from {ggplot2}. (#50)
84127

85128
## class 'eigen'
86129

87-
Methods are added for the 'eigen' class returned by `eigen()`, and the internal `eigen_ord()` function and its methods are updated accordingly.
130+
Methods are added for the 'eigen' class returned by `eigen()`, and the internal
131+
`eigen_ord()` function and its methods are updated accordingly.
88132

89133
## list tidiers (breaking change)
90134

91-
The previous version extended the 'list' method for {broom}'s `tidy()` and `glance()` functions to recognize the output of `cmdscale()` and of `cancor()`.
92-
These have been spun off to a nascent helper package, {broom.list}, to reduce size and prevent attachment warnings.
135+
The previous version extended the 'list' method for {broom}'s `tidy()` and
136+
`glance()` functions to recognize the output of `cmdscale()` and of `cancor()`.
137+
These have been spun off to a nascent helper package, {broom.list}, to reduce
138+
size and prevent attachment warnings.
93139

94140
# ordr 0.1.0
95141

96-
In addition to minor changes, the following substantive changes are made from v0.0.2:
142+
In addition to minor changes, the following substantive changes are made from
143+
v0.0.2:
97144

98145
## augmentation
99146

100-
The column names of `augment_ord()` and `tidy()` outputs are no longer prefixed by periods.
147+
The column names of `augment_ord()` and `tidy()` outputs are no longer prefixed
148+
by periods.
101149

102150
## list tidiers
103151

104152
A new list tidier for `cancor()` output is introduced.
105153

106154
## negation
107155

108-
Tools to negate a subset of artificial dimensions, adapted from the sandboxed set of alignment tools, are provided.
156+
Tools to negate a subset of artificial dimensions, adapted from the sandboxed
157+
set of alignment tools, are provided.
109158

110159
## convenience function
111160

112161
The `ordinate()` function is now a generic with methods for four data classes.
113162

114163
## ggbiplot
115164

116-
The logical `prediction` parameter is replaced with the character-valued `axis.type`, based on the `ax.type` parameter used in {UBbipl} (Gower, Gardner--Lubbe, & le Roux, 2011).
165+
The logical `prediction` parameter is replaced with the character-valued
166+
`axis.type`, based on the `ax.type` parameter used in {UBbipl} (Gower,
167+
Gardner--Lubbe, & le Roux, 2011).
117168

118169
## tests
119170

120-
Unit tests are overhauled to remove contexts, omit ad hoc tests, standardize method tests, and cover additional methods.
171+
Unit tests are overhauled to remove contexts, omit ad hoc tests, standardize
172+
method tests, and cover additional methods.
121173

122174
## documentation
123175

124-
The term 'accessor', used to refer to S3 class methods to recover standardized model components, has been changed to 'recoverer'.
176+
The term 'accessor', used to refer to S3 class methods to recover standardized
177+
model components, has been changed to 'recoverer'.
125178

126179
# ordr 0.0.2
127180

128-
This pre-release makes several substantive changes in preparation for CRAN submission.
181+
This pre-release makes several substantive changes in preparation for CRAN
182+
submission.
129183

130184
## element types
131185

132-
Annotation of active and supplementary elements is standardized: The character augmentation `.element` replaces the logical `.supplement`, and class methods either omit it entirely (when all retrieved elements are active) or include it in both row and column augmentation (when either includes supplementary elements). The value of `.element` is either 'active' or a type of supplement, e.g. 'score'.
186+
Annotation of active and supplementary elements is standardized: The character
187+
augmentation `.element` replaces the logical `.supplement`, and class methods
188+
either omit it entirely (when all retrieved elements are active) or include it
189+
in both row and column augmentation (when either includes supplementary
190+
elements). The value of `.element` is either 'active' or a type of supplement,
191+
e.g. 'score'.
133192

134193
## dependencies
135194

136195
Extraneous dependencies are dropped to reduce overhead. This takes two forms:
137196

138-
1. Methods for classes from specialty (lower-priority) packages ({candisc} and {ca}) are moved to {ordr.extra} and replaced with methods for classes from higher-priority packages ({stats} and {MASS}).
197+
1. Methods for classes from specialty (lower-priority) packages ({candisc} and
198+
{ca}) are moved to {ordr.extra} and replaced with methods for classes from
199+
higher-priority packages ({stats} and {MASS}).
139200
2. One-off uses of specialty packages for examples and vignettes are replaced.
140201

141202
## documentation
142203

143-
The `Description` field in DESCRIPTION is expanded and documentation throughout is slightly revised, including some new references.
204+
The `Description` field in DESCRIPTION is expanded and documentation throughout
205+
is slightly revised, including some new references.
144206

145207
# ordr 0.0.1
146208

147209
This is a pre-release in anticipation of a first CRAN submission.
148-
Upgrades between this pre-release and CRAN submission will focus on addressing issues.
210+
Upgrades between this pre-release and CRAN submission will focus on addressing
211+
issues.

0 commit comments

Comments
 (0)