forked from LabAsim/lavaanPlot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
48 lines (34 loc) · 2.58 KB
/
README.Rmd
File metadata and controls
48 lines (34 loc) · 2.58 KB
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
---
output: github_document
always_allow_html: true
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
<!-- badges: start -->
[](https://github.com/LabAsim/lavaanPlot/actions/workflows/R-CMD-check.yaml)
[](https://github.com/LabAsim/lavaanplot/actions/workflows/test-coverage.yaml)
[](https://codecov.io/github/LabAsim/lavaanPlot)
[](https://github.com/LabAsim/lavaanPlot/commits/main)
<!-- badges: end -->
## Current status
The [original package](https://github.com/alishinski/lavaanPlot) is not maintained for a long time, so I [forked](https://github.com/LabAsim/lavaanPlot) it and added some features that I needed for my research and they were not available. They will be documented in a new vignette.
The new documentation is available [here](https://labasim.github.io/lavaanPlot/).
## Background
The lavaan package is an excellent package for structural equation models, and the DiagrammeR package is an excellent package for producing nice looking graph diagrams. As of right now, the lavaan package has no built in plotting functions for models, and the available options from external packages don’t look as nice and aren’t as easy to use as DiagrammeR, in my opinion. Of course, you can use DiagrammeR to build path diagrams for your models, but it requires you to build the diagram specification manually. This package exists to streamline that process, allowing you to plot your lavaan models directly, without having to translate them into the DOT language specification that DiagrammeR uses.
## Installation
You can also install the development version of lavaanPlot from GitHub with:
```{r gh-installation, eval = FALSE}
install.packages("devtools")
devtools::install_github("labasim/lavaanPlot")
```
```{r, include=FALSE}
install.packages("webshot", repos = "http://cran.us.r-project.org")
webshot::install_phantomjs(force=T)
```
# Learning More
To learn more, check out the vignettes.
## Citing lavaanPlot
If you found lavaanPlot useful and used the plots in a publication, I ask that you please cite the package.
## Contributing
I welcome any and all contributions from people using the package, so please share github issues here if there are problems you encounter or features you want to suggest.