Skip to content

Commit b1bacf7

Browse files
committed
Updated news with current changes
1 parent 24051ea commit b1bacf7

File tree

2 files changed

+111
-36
lines changed

2 files changed

+111
-36
lines changed

NEWS.Rmd

Lines changed: 105 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,22 @@ output:
99

1010
# ShortForm
1111

12-
# *News*
12+
# *News*
13+
14+
# ShortForm v0.5.6
15+
16+
- Updates focused on `{antcolony.lavaan}`.
17+
- lavaan.model.specs now defaults to the default arugments. If a user removes the arguments, they will be provided for them. If a user overwrites a specific argument (e.g., `estimator = 'wls'`), that will be respected.
18+
- Some minor adjustments to checking fitted models for specific warnings/errors that should result in better functioning when these do not exist.
19+
20+
# ShortForm v0.5.5
21+
22+
- Further updates to handle changes to `lavaan` error/warning messages more gracefully. These should continue into the future for the SA and ACo methods without additional issues.
23+
24+
# ShortForm v0.5.4
25+
26+
- Updates to handle changes to `lavaan` error/warning messages
27+
- Fixed internal documentation to match current standards
1328

1429
# ShortForm v0.5.3
1530

@@ -21,104 +36,158 @@ output:
2136

2237
## Bugfixes
2338

24-
- This version fixes minor bugs, most associated with CRAN messages
25-
and warnings
39+
- This version fixes minor bugs, most associated with CRAN messages and
40+
warnings
2641

2742
# ShortForm v0.5.0
2843

2944
## Introduction of S4 Function Classes
3045

31-
* This version (re-)introduces classes to each of the main function outputs using S4 methods (instead of the S3 methods present in the prior version)
32-
* Each method has a `show` (print), `summary`, and `plot` method that provides revamped, concise information about the algorithm
33-
* Functions have been updated to accommodate these changes
46+
- This version (re-)introduces classes to each of the main function
47+
outputs using S4 methods (instead of the S3 methods present in the
48+
prior version)
49+
- Each method has a `show` (print), `summary`, and `plot` method that
50+
provides revamped, concise information about the algorithm
51+
- Functions have been updated to accommodate these changes
3452

3553
## Parallelized Short Form Functions
3654

37-
* Some short form functions have been modified to work with parallel processors, resulting in noticeably faster results particularly when the solution space is larger (e.g., more starting items) or with more complex models
38-
- This has resulted in some function argument changes. Please check any code that was written with older versions!
39-
55+
- Some short form functions have been modified to work with parallel
56+
processors, resulting in noticeably faster results particularly when
57+
the solution space is larger (e.g., more starting items) or with more
58+
complex models
59+
- This has resulted in some function argument changes. Please check
60+
any code that was written with older versions!
61+
4062
## Minor cleanup
41-
42-
* Removed some unneeded code
63+
64+
- Removed some unneeded code
4365

4466
# ShortForm 0.4.6
4567

4668
## Updated argument check
47-
* The argument check for fit statistics (ACO, SA) were updated to include fit statistics related to the "WLSMV" estimator (i.e, for ordered data).
69+
70+
- The argument check for fit statistics (ACO, SA) were updated to
71+
include fit statistics related to the “WLSMV” estimator (i.e, for
72+
ordered data).
4873

4974
## Bugfixes
5075

51-
* A bug in the SA function that sometimes resulted in improper items has been fixed.
76+
- A bug in the SA function that sometimes resulted in improper items has
77+
been fixed.
5278

53-
* A bug in the Tabu short form function that caused the Tabu list to be erased if the best criterion value was reached has been fixed.
79+
- A bug in the Tabu short form function that caused the Tabu list to be
80+
erased if the best criterion value was reached has been fixed.
5481

5582
# ShortForm 0.4.5
5683

5784
## Extra arugment checks
5885

59-
* There are now additional checks for the function arguments related to the fit statistics (ACO, SA) and the fit statistic tests (ACO) with informative warnings for when the function arguments are not valid.
86+
- There are now additional checks for the function arguments related to
87+
the fit statistics (ACO, SA) and the fit statistic tests (ACO) with
88+
informative warnings for when the function arguments are not valid.
6089

6190
# ShortForm 0.4.2
6291

6392
## Introduction of Function Classes
6493

65-
* This version introduces classes to each of the main function outputs (`antcolony.lavaan` == "antcolony", `simulatedAnnealing` == "simulatedAnnealing", `tabuShortForm` == "tabu")
94+
- This version introduces classes to each of the main function outputs
95+
(`antcolony.lavaan` == “antcolony”, `simulatedAnnealing` ==
96+
“simulatedAnnealing”, `tabuShortForm` == “tabu”)
6697

67-
* This will allow for `plot` and `print` methods for each of these functions
98+
- This will allow for `plot` and `print` methods for each of these
99+
functions
68100

69101
## Broken functionality: antcolony_plot
70102

71-
* The function `antcolony_plot` was replaced with `plot.antcolony` (aka, a plot method)
103+
- The function `antcolony_plot` was replaced with `plot.antcolony` (aka,
104+
a plot method)
72105

73106
## New functionality: S3 method for plotting
74107

75-
* With the addition of classes, a plot method and accompanying documentation has been added.
108+
- With the addition of classes, a plot method and accompanying
109+
documentation has been added.
76110

77-
* Future updates will expand S3 methods for `print()` and `summary()`
111+
- Future updates will expand S3 methods for `print()` and `summary()`
78112

79113
## Bugfixes
80114

81-
* Bugfixes to the main functions when using them to create shortforms of bifactor models.
82-
* They should now produce actual bifactor shortforms (in 0.4.1, sometimes the item names would be cut off in later iterations [FIXED] and the relationship between latent variables would be changed when they should have been kept constant [FIXED]).
115+
- Bugfixes to the main functions when using them to create shortforms of
116+
bifactor models.
117+
- They should now produce actual bifactor shortforms (in 0.4.1,
118+
sometimes the item names would be cut off in later iterations
119+
\[FIXED\] and the relationship between latent variables would be
120+
changed when they should have been kept constant \[FIXED\]).
83121

84122
## Added a package loading message
85123

86-
* Now, when using an interactive R session, a package message is printed out (with a little Penguin holding it all up)!
124+
- Now, when using an interactive R session, a package message is printed
125+
out (with a little Penguin holding it all up)!
87126

88127
# ShortForm 0.4.1
89128

90129
## New functionality: Simulated Annealing
91130

92-
* The Simulated Annealing (SA) algorithm has been added to the package, with a single user-facing function `simulatedAnnealing()`.
93-
* SA can be used on anything lavaan can run, though the current implementation focuses on traditional confirmatory models using `lavaan::cfa()`. However, there are plans for more user control in the modeling process to allow for other model defaults.
131+
- The Simulated Annealing (SA) algorithm has been added to the package,
132+
with a single user-facing function `simulatedAnnealing()`.
133+
- SA can be used on anything lavaan can run, though the current
134+
implementation focuses on traditional confirmatory models using
135+
`lavaan::cfa()`. However, there are plans for more user control in the
136+
modeling process to allow for other model defaults.
94137

95138
## New functionality: Tabu Search (Short Form)
96139

97-
* An adaptation of the Tabu search to short form creation has been added.
140+
- An adaptation of the Tabu search to short form creation has been
141+
added.
98142

99143
## New functionality: ACO Plots
100144

101-
* The `antcolony_lavaan()` function has been modified so that it no longer will print a `summaryfile.txt`. Rather, the function maintains the old summary file as an internal object and returns it after completion,
102-
* The new function `antcolony_plot()` takes the results from `antcolony_lavaan()` and creates three graphs: (a) a plot showing how pheremone levels change as the algorithm progresses, (b) a plot showing how the mean value of the regression coefficients changes as the algorithm progresses, and (c) a plot showing how the mean variance explained changes as the algorithm progresses.
145+
- The `antcolony_lavaan()` function has been modified so that it no
146+
longer will print a `summaryfile.txt`. Rather, the function maintains
147+
the old summary file as an internal object and returns it after
148+
completion,
149+
- The new function `antcolony_plot()` takes the results from
150+
`antcolony_lavaan()` and creates three graphs: (a) a plot showing how
151+
pheremone levels change as the algorithm progresses, (b) a plot
152+
showing how the mean value of the regression coefficients changes as
153+
the algorithm progresses, and (c) a plot showing how the mean variance
154+
explained changes as the algorithm progresses.
103155

104156
## New functionality: Bifactor Models
105157

106-
* Each of the short form functions utilizing lavaan (`antcolony.lavaan()`, `simulatedAnnealing()`, `tabuShortForm()`) are capable of handling bifactor models.
107-
* In theory, this means relatively arbitrary models can be specified as well, but the functions utilize the "~" and "~~" operators for the additional functionality as well as the `bifactor` logical option. No guarantee that an arbitrary model will work beyond those currently tested.
158+
- Each of the short form functions utilizing lavaan
159+
(`antcolony.lavaan()`, `simulatedAnnealing()`, `tabuShortForm()`) are
160+
capable of handling bifactor models.
161+
- In theory, this means relatively arbitrary models can be specified as
162+
well, but the functions utilize the “~” and “\~~” operators for the
163+
additional functionality as well as the `bifactor` logical option. No
164+
guarantee that an arbitrary model will work beyond those currently
165+
tested.
108166

109167
### Minor revisions
110168

111-
* The lavaan-based functions all have more controlled output to the R console. This is most noticeable with the `antcolony.lavaan()` function.
169+
- The lavaan-based functions all have more controlled output to the R
170+
console. This is most noticeable with the `antcolony.lavaan()`
171+
function.
112172

113173
# ShortForm 0.4.0
114174

115175
## New functionality: Tabu Search
116176

117-
* The Tabu search has been added to the package, with user-facing functions `tabu.sem()` and `search.prep()` for most of the heavy lifting and various helper and internal functions. The code was taken primarily from Carl Falk and Katerina Marcoulides (see Marcoulides, K. M., & Falk, C. F. (2018). Model Specification Searches in Structural Equation Modeling with R. Structural Equation Modeling: A Multidisciplinary Journal, 1-8.). These have been tested in limited circumstances, so please report any bugs as you find them!
177+
- The Tabu search has been added to the package, with user-facing
178+
functions `tabu.sem()` and `search.prep()` for most of the heavy
179+
lifting and various helper and internal functions. The code was taken
180+
primarily from Carl Falk and Katerina Marcoulides (see Marcoulides, K.
181+
M., & Falk, C. F. (2018). Model Specification Searches in Structural
182+
Equation Modeling with R. Structural Equation Modeling: A
183+
Multidisciplinary Journal, 1-8.). These have been tested in limited
184+
circumstances, so please report any bugs as you find them!
118185

119186
## Minor changes
120187

121-
* NEWS.md created.
122-
* Description file updated.
123-
* Authorship has been updated and URLs have been added to the ant colony functions.
124-
* No bugs have been found in the package thus far, but just a reminder for any users that bug reports are helpful and welcome.
188+
- NEWS.md created.
189+
- Description file updated.
190+
- Authorship has been updated and URLs have been added to the ant colony
191+
functions.
192+
- No bugs have been found in the package thus far, but just a reminder
193+
for any users that bug reports are helpful and welcome.

NEWS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33

44
# *News*
55

6+
# ShortForm v0.5.6
7+
8+
- Updates focused on `{antcolony.lavaan}`.
9+
- lavaan.model.specs now defaults to the default arugments. If a user removes the arguments, they will be provided for them. If a user overwrites a specific argument (e.g., `estimator = 'wls'`), that will be respected.
10+
- Some minor adjustments to checking fitted models for specific warnings/errors that should result in better functioning when these do not exist.
11+
612
# ShortForm v0.5.5
713

814
- Further updates to handle changes to `lavaan` error/warning messages more gracefully. These should continue into the future for the SA and ACo methods without additional issues.

0 commit comments

Comments
 (0)