-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathREADME.Rmd
98 lines (69 loc) · 5.65 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# tidySEM <a href='https://github.com/cjvanlissa/tidySEM'><img src='https://github.com/cjvanlissa/tidySEM/raw/master/docs/badge.png' align="right" height="139" /></a>
[](https://cran.r-project.org/package=tidySEM)
[](https://r-pkg.org/pkg/tidySEM)
[](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[](https://github.com/cjvanlissa/tidySEM/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/cjvanlissa/tidySEM?branch=master)
[](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html)
<!--[](https://codeofmerit.org/CODE_OF_CONDUCT.md)-->
The package `tidySEM` provides a 'tidy' workflow for conducting, reporting, and plotting structural equation modeling analyses. It does not perform model estimation, but instead allows users to estimate models in a software-agnostic way, using either the free open source R packages `lavaan` or `OpenMx`, or the commercial closed-source program `Mplus` (controlled through the R package `MplusAutomation`). The aim of `tidySEM` is to provide three specific functions:
1. Generate model syntax in a top-down, tidy way,
* With particular attention to specifying mixture models in `OpenMx`
2. Tabulate model output in a publication-ready, uniform manner,
3. Make easily customizable graphs for SEM-models.
These functions are designed with the [*tidy tools manifesto* (Wickham, last updated 23-11-2019)](https://tidyverse.tidyverse.org/articles/manifesto.html) in mind, and interface with the existing suite of packages in the [`tidyverse`](https://tidyverse.tidyverse.org/).
## Installation
You can install the public release of `tidySEM` from CRAN with:
```{r, eval = F}
install.packages("tidySEM")
```
If you want access to the latest developer version,
including features that may not yet be finalized,
you can install the development version of `tidySEM` from R-universe with:
```{r runiverseinstallation, eval = FALSE}
install.packages('tidySEM',
repos = c('https://cjvanlissa.r-universe.dev',
'https://cloud.r-project.org'))
```
And if you are a developer and want to contribute to `tidySEM`,
or want to install a specific historical version of the package,
you can install directly from GitHub with:
```{r gh-installation, eval = FALSE}
install.packages("remotes")
remotes::install_github('cjvanlissa/tidySEM')
```
## Documentation
Every user-facing function in the package is documented, and the documentation can be accessed by running `?function_name` in the R console, e.g., `?graph_sem`.
Furthermore, there are three main vignettes, describing the three main tracks of `tidySEM` functions:
1. A [vignette about generating syntax and estimating models](https://cjvanlissa.github.io/tidySEM/articles/Generating_syntax.html)
2. A [vignette about tabulating results](https://cjvanlissa.github.io/tidySEM/articles/Tabulating_results.html)
3. A [vignette about making graphs](https://cjvanlissa.github.io/tidySEM/articles/Plotting_graphs.html)
* An additional vignette describes the [graphing conventions](https://cjvanlissa.github.io/tidySEM/articles/sem_graph.html) for
structural equation models.
## Citing tidySEM
You can cite the R-package with the following citation:
> Van Lissa, C. J., (2019). *tidySEM: Tidy structural equation modeling.* R package version 0.2.1. https://github.com/cjvanlissa/tidySEM/
To cite the latent class analysis functionality in tidySEM, cite:
> Van Lissa, C. J., Garnier-Villarreal, M., & Anadria, D. (2023). *Recommended Practices in Latent Class Analysis using the Open-Source R-Package tidySEM.* Structural Equation Modeling. https://doi.org/10.1080/10705511.2023.2250920
## Contributing and Contact Information
If you have ideas, please get involved. You can contribute by opening an issue on 'GitHub', or sending a pull request with proposed features (see further instructions below).
* File a 'GitHub' issue [here](https://github.com/cjvanlissa/tidySEM)
* Make a pull request [here](https://github.com/cjvanlissa/tidySEM/pulls)
By participating in this project, you agree to abide by the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
### Pull requests
* Please always contribute via pull request instead of committing to master, so I can review the contribution.
+ You can either fork the repository to your own account and then submit a pull request, or make minor changes directly on this repository, and choose to commit them to a different branch and send a pull request when you save those changes
* If you fix an issue, in your Commit message, please write “closes #issuenumber” so we can trace which commits fixed which issues
* Please add a line to NEWS.md for each bug fix or feature contribution
* Please increment the minor version number in DESCRIPTION, e.g.: 0.2.3.1 -> 0.2.3.2