NEWS

dySEM 2.1.0

Note on scope. v2.0.0 introduces substantial new functionality developed after the v1.4.2 JOSS archival release (see openjournals/joss-reviews#10115). These additions (multi-group support, scriptTwoCross(), Monte Carlo simulation scripters, GUI support, "orthogonal" constraint tokens, etc.) were not part of the JOSS-reviewed release and should not be cited as JOSS-reviewed functionality. The JOSS-reviewed and -archived version is v1.4.2 (tag v1.4.2, branch release/joss-1.4.2).
scriptObsAPIM() now uses the same structural constraint arguments as scriptAPIM() (constr_dy_x_struct, constr_dy_y_struct, constr_dy_xy_struct, includeMeanStruct, est_k), with defaults aligned to an indistinguishable observed APIM. equate and k are deprecated in favor of constr_dy_xy_struct and est_k. Orthogonal dyadic covariances are supported via "orthogonal" in the *_struct vectors. Saving syntax now requires both writeTo and fileName.
scriptAPIM() documents and validates "orthogonal" in constr_dy_x_struct and constr_dy_y_struct (zero latent dyadic covariance); unknown constraint tokens now error consistently.
Initial multi-group support! (for scriptUni() and scriptCor())!
Boutique bi-constructc cross-sectional model specification with scriptTwoCross()
Initial scripting support for Monte Carlo simulation (via forthcoming updates to dySim: https://jsakaluk.github.io/dySim/)
Initial GUI support

JOSS review release. Incorporates the documentation and example-script corrections contributed by @smasongarrison in PR #156: link formatting and typo fixes in R/DRES-data.R, man/DRES.Rd, paper/paper.md, paper/paper.html, and vignettes/dySEM.Rmd. No user-facing code changes relative to 1.4.1; this is the version archived with a DOI for the JOSS submission (openjournals/joss-reviews#10115). Lives on branch release/joss-1.4.2 at tag v1.4.2.

Much more extensive unit testing coverage
New pnrqM dataset for use in vignettes and examples (multi-construct dyadic data) courtesy of @mprine and @TheGlazedDonut

outputParamTab() can now generate df of correlation matrix of latent variables in the model
vignettes for Correlated Dyadic Factors Model, Mulitple Correlated Dyadic Factors Model, and Latent APIM written in advance of preprint/submission of Sakaluk & Camanto
added verbose option to scrapeVarCross() to print progress messages during data scraping

@omarjcamanto has built a beauty function called outputUniConstructComp() for comparing different varieties of uniconstruct models.
added a new argument (includeMeanStruct) to scriptAPIM() (and soon to be for other bi-construct scripters). By defaulting to FALSE, this will enable these scripted models to cooperate with dynamic fit indexes (which currently do not support mean structures)

deep dive ensuring correct specification + unit tests for all uniconstruct models across FF and MV scale-setting options

add two new exemplar datasets, imsM and prqcQ (both of which contain multi-construct data) for use in the vignettes and examples
scriptHier() and scriptBifac() added to list of uni-construct scripters

scriptCor() functionality assumes scripting of correlated factor models for 1-construct dyadic models; multi-construct correlated factor models now handled by scriptCFA() (previously for uni-construct correlated factor models)

New scriptUni() functionality for univariate dyadic SEM models, lead @omarjcamanto
New functionality for dyadic CFA models with multiple factors (e.g., from subscales), lead by @jsakaluk

Deprecated outputModel(), in favour of two separate functions: outputParamFig() (for path diagram), and outputParamTab() (for table of parameter estimates)
Deprecated getInvarCompTable(), in favour of outputInvarCompTable() (for table of invariance comparisons); this now returns a more flexible data frame (with optionality for gt())
Created outputContraintTests() (for table of parameter-specific dyadic noninvariance tests with Langrange multipliers); this now returns a more flexible tibble (with optionality for gt())

Added some basic dyadic EFA functionality (simulations forthcoming), including scripters, a model fitting and comparison sequence wrapper, and some unit tests

Marks the first release of dySEM on CRAN. From here on out, the NEWS.md file will be updated with each new release.

Implemented a new style of arguments for constraints on the measurement model (e.g., constr_dy_x_meas) and structural model (e.g., constr_dy_x_struct) for the scripters, in order to make addition of arguments for other design-based constraints (e.g., groups, waves of assessment) easier in future releases. These arguments replace the previous model and equate arguments in the scripters (which have been deprecated) and default to the most constrained (i.e., indistinguishable) version of the model being scripted.

@omarjcamanto joins the dySEM team as a co-author! Omar has been a major contributor to the dySEM project during the Fall 2023 semester, and we are excited to have him on board moving forward.
We now have unit tests! While coverage has taken a hit in our switch to the new arguments for constraints, there is a critical mass of tests in place for scrapeVarCross(), scriptCFA() and scriptAPIM(), and the scriptHelpers underlying them. For scriptCFA() and scriptAPIM(), there are specific tests ensuring the appropriate number of estimated parameters and dfs, and equivalent model fit for the FF and MV scale-setting versions (thanks to @omarjcamanto for his work on these). We will continue to add tests for other functions in future releases, as well as a vignette explaining how we use number of estimated parameters and dfs, and model fit indexes in unit tests for quality assurance in dySEM's model specification.
We have added two new user-facing wrapper functions: getContraintTests() (which should help with more insights into what items are driving dyadic noninvariance), and getInvarCompTable() (which facilitates a more parsimony-favouring and inclusive "build-up" invariance testing sequence, beginning with most constrained model and relaxing constraints in a step-wise fashion).

We have made a number of updates to our documentation and vignettes, in order to bring these into line with the BREAKING and Major changes of this release.