Skip to content

Commit aa227ae

Browse files
committed
update README & metadata
1 parent 975ab73 commit aa227ae

5 files changed

Lines changed: 84 additions & 72 deletions

File tree

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Type: Package
33
Title: Path Diagrams for 'Lavaan' Models via 'DiagrammeR'
44
Version: 0.8.1
55
Author: Alex Lishinski
6-
Maintainer: Alex Lishinski <alexlishinski@gmail.com>
7-
URL: https://github.com/alishinski/lavaanPlot, https://lavaanplot.alexlishinski.com/, http://alexlishinski.com/lavaanPlot/
6+
Maintainer: Lab Asim
7+
URL: https://github.com/labasim/lavaanPlot
88
Description: Plots path diagrams from models in 'lavaan' using the plotting
99
functionality from the 'DiagrammeR' package. 'DiagrammeR' provides nice path diagrams
1010
via 'Graphviz', and these functions make it easy to generate these diagrams from a

NEWS.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
1-
# lavaanPlot 0.3.0
21

3-
* Added support for latent variables (denoted by circles) in plots
2+
# lavaanPlot 0.8.1
43

5-
* Added support for edge labels with significant coefficients
4+
* Fixed bug with the standardized coefficents in `lavaanPlot2`
65

7-
# lavaanPlot 0.4.0
6+
# lavaanPlot 0.8.0
87

9-
* Added support for latent variable loading labels
8+
* Introducing conditional formatting which allows one to apply different formatting to different sets of nodes and edges
9+
* Version 0.8.0, is introducing conditional formatting to the `lavaanPlot` package, using the new `formatting` function. Check out the new vignette explaining the changes here: [Conditional Formatting in LavaanPlot](https://lavaanplot.alexlishinski.com/Conditional_Formatting)
1010

11-
* Added support for covariance edges
11+
# lavaanPlot 0.7.0
1212

13-
* Corrected the direction of arrows for latent variable loadings
13+
* Introducing `lavaanPlot2` function, which replicates the old functionality in a more flexible platform
14+
* Version 0.7.0, introduced a new iteration of the `lavaanPlot` function, called `lavaanPlot2`. Check out a new vignette explaining some of the changes here: [Improvements to lavaanPlot](https://lavaanplot.alexlishinski.com/improvements_to_lavaanplot)
1415

15-
# lavaanPlot 0.5.0
16+
# lavaanPlot 0.6.3
1617

17-
* Added support for covariance edge labels
18+
* Added support for specifying dimensions of saved png files
1819

19-
* Added support for significance stars
20+
* Updated vignette for layout graph options
2021

21-
# lavaanPlot 0.5.1
22+
* Added package tests
2223

23-
* Fixed bug caused by . in variable names
2424

25-
* simplified the functions using the ... argument
25+
# lavaanPlot 0.6.2
2626

27-
* fixed significance stars to work with standardized and non-standardized coefficients
27+
* Fixed issues with suggested packages that were causing trouble for CRAN submission
2828

29-
* Changed significance stars so you can choose which parameters to use them with
29+
# lavaanPlot 0.6.0
30+
31+
* added functions to save plots as images and embed plots in pdfs with Rmarkdown
3032

3133
# lavaanPlot 0.5.2
3234

@@ -36,30 +38,33 @@
3638

3739
* Plots now show residual covariances
3840

39-
# lavaanPlot 0.6.0
41+
# lavaanPlot 0.5.1
4042

41-
* added functions to save plots as images and embed plots in pdfs with Rmarkdown
43+
* Fixed bug caused by . in variable names
4244

43-
# lavaanPlot 0.6.2
45+
* simplified the functions using the ... argument
4446

45-
* Fixed issues with suggested packages that were causing trouble for CRAN submission
47+
* fixed significance stars to work with standardized and non-standardized coefficients
4648

47-
# lavaanPlot 0.6.3
49+
* Changed significance stars so you can choose which parameters to use them with
4850

49-
* Added support for specifying dimensions of saved png files
51+
# lavaanPlot 0.5.0
5052

51-
* Updated vignette for layout graph options
53+
* Added support for covariance edge labels
5254

53-
* Added package tests
55+
* Added support for significance stars
5456

55-
# lavaanPlot 0.7.0
5657

57-
* Introducing `lavaanPlot2` function, which replicates the old functionality in a more flexible platform
58+
# lavaanPlot 0.4.0
5859

59-
# lavaanPlot 0.8.0
60+
* Added support for latent variable loading labels
6061

61-
* Introducing conditional formatting which allows one to apply different formatting to different sets of nodes and edges
62+
* Added support for covariance edges
6263

63-
# lavaanPlot 0.8.1
64+
* Corrected the direction of arrows for latent variable loadings
6465

65-
* Fixed bug with the standardized coefficents in `lavaanPlot2`
66+
# lavaanPlot 0.3.0
67+
68+
* Added support for latent variables (denoted by circles) in plots
69+
70+
* Added support for edge labels with significant coefficients

README.Rmd

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,36 @@ always_allow_html: true
66
```{r setup, include=FALSE}
77
knitr::opts_chunk$set(echo = TRUE)
88
```
9+
[![R-CMD-check.yaml](https://github.com/LabAsim/lavaanPlot/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/LabAsim/lavaanPlot/actions/workflows/R-CMD-check.yaml)
910

10-
[![CRAN status](https://www.r-pkg.org/badges/version/lavaanPlot)](https://cran.r-project.org/package=lavaanPlot)
11-
[![](https://cranlogs.r-pkg.org/badges/lavaanPlot)](https://cran.r-project.org/package=lavaanPlot)
12-
[![R-CMD-check](https://github.com/alishinski/lavaanPlot/workflows/R-CMD-check/badge.svg)](https://github.com/alishinski/lavaanPlot/actions)
11+
## Current status
1312

14-
## News
13+
The original package is not maintained for a long time, so I forked it and add some features that I needed for my research and they were not available. They will be documented in a new vignette.
1514

16-
Version 0.7.0, is introducing a new iteration of the `lavaanPlot` function, called `lavaanPlot2`. Check out a new vignette explaining some of the changes here: [Improvements to lavaanPlot](https://lavaanplot.alexlishinski.com/improvements_to_lavaanplot)
15+
## Background
1716

18-
Version 0.8.0, is introducing conditional formatting to the `lavaanPlot` package, using the new `formatting` function. Check out the new vignette explaining the changes here: [Conditional Formatting in LavaanPlot](https://lavaanplot.alexlishinski.com/Conditional_Formatting)
17+
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.
1918

2019
## Background
2120

2221
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.
2322

2423
## Installation
2524

26-
You can install lavaanPlot from CRAN with:
27-
28-
```{r, eval = F}
29-
install.packages("lavaanPlot")
30-
```
31-
3225
You can also install the development version of lavaanPlot from GitHub with:
3326

3427
```{r gh-installation, eval = FALSE}
3528
install.packages("devtools")
36-
devtools::install_github("alishinski/lavaanPlot")
29+
devtools::install_github("labasim/lavaanPlot")
3730
```
3831

32+
```{r, echo=FALSE}
33+
install.packages("webshot", repos = "http://cran.us.r-project.org")
34+
webshot::install_phantomjs()
35+
36+
```
37+
38+
3939
## Examples
4040

4141
Here's a quick example using the `mtcars` data set.
@@ -56,7 +56,7 @@ summary(fit)
5656
Then using that model fit object, simply call the `lavaanPlot` function, specifying your desired graph parameters.
5757

5858
```{r}
59-
lavaanPlot(model = fit, node_options = list(shape = "box", fontname = "Helvetica"), edge_options = list(color = "grey"), coefs = F)
59+
lavaanPlot(model = fit, node_options = list(shape = "box", fontname = "Helvetica"), edge_options = list(color = "grey"), coefs = T)
6060
```
6161

6262
There is also functionality to save these plots as images and embed them in pdf output documents.

README.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
11

2-
[![CRAN
3-
status](https://www.r-pkg.org/badges/version/lavaanPlot)](https://cran.r-project.org/package=lavaanPlot)
4-
[![](https://cranlogs.r-pkg.org/badges/lavaanPlot)](https://cran.r-project.org/package=lavaanPlot)
5-
[![R-CMD-check](https://github.com/alishinski/lavaanPlot/workflows/R-CMD-check/badge.svg)](https://github.com/alishinski/lavaanPlot/actions)
2+
[![R-CMD-check.yaml](https://github.com/LabAsim/lavaanPlot/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/LabAsim/lavaanPlot/actions/workflows/R-CMD-check.yaml)
63

7-
## News
4+
## Current status
85

9-
Version 0.7.0, introduced a new iteration of the `lavaanPlot`
10-
function, called `lavaanPlot2`. Check out a new vignette explaining some
11-
of the changes here: [Improvements to
12-
lavaanPlot](https://lavaanplot.alexlishinski.com/improvements_to_lavaanplot)
13-
14-
Version 0.8.0, is introducing conditional formatting to the `lavaanPlot`
15-
package, using the new `formatting` function. Check out the new vignette
16-
explaining the changes here: [Conditional Formatting in
17-
LavaanPlot](https://lavaanplot.alexlishinski.com/Conditional_Formatting)
6+
The original package is not maintained for a long time, so I forked it
7+
and add some features that I needed for my research and they were not
8+
available. They will be documented in a new vignette.
189

1910
## Background
2011

@@ -29,22 +20,39 @@ specification manually. This package exists to streamline that process,
2920
allowing you to plot your lavaan models directly, without having to
3021
translate them into the DOT language specification that DiagrammeR uses.
3122

32-
## Installation
23+
## Background
3324

34-
You can install lavaanPlot from CRAN with:
25+
The lavaan package is an excellent package for structural equation
26+
models, and the DiagrammeR package is an excellent package for producing
27+
nice looking graph diagrams. As of right now, the lavaan package has no
28+
built in plotting functions for models, and the available options from
29+
external packages don’t look as nice and aren’t as easy to use as
30+
DiagrammeR, in my opinion. Of course, you can use DiagrammeR to build
31+
path diagrams for your models, but it requires you to build the diagram
32+
specification manually. This package exists to streamline that process,
33+
allowing you to plot your lavaan models directly, without having to
34+
translate them into the DOT language specification that DiagrammeR uses.
3535

36-
``` r
37-
install.packages("lavaanPlot")
38-
```
36+
## Installation
3937

4038
You can also install the development version of lavaanPlot from GitHub
4139
with:
4240

4341
``` r
4442
install.packages("devtools")
45-
devtools::install_github("alishinski/lavaanPlot")
43+
devtools::install_github("labasim/lavaanPlot")
4644
```
4745

46+
## Installing package into 'C:/Users/lapto/AppData/Local/R/win-library/4.5'
47+
## (as 'lib' is unspecified)
48+
49+
## package 'webshot' successfully unpacked and MD5 sums checked
50+
##
51+
## The downloaded binary packages are in
52+
## C:\Users\lapto\AppData\Local\Temp\RtmpcvxvaF\downloaded_packages
53+
54+
## It seems that the version of `phantomjs` installed is greater than or equal to the requested version.To install the requested version or downgrade to another version, use `force = TRUE`.
55+
4856
## Examples
4957

5058
Here’s a quick example using the `mtcars` data set.
@@ -56,7 +64,7 @@ regression relationships and latent variable - indicator relationships.
5664
library(lavaan)
5765
```
5866

59-
## This is lavaan 0.6-11
67+
## This is lavaan 0.6-19
6068
## lavaan is FREE software! Please report any bugs.
6169

6270
``` r
@@ -69,14 +77,14 @@ fit <- sem(model, data = mtcars)
6977
summary(fit)
7078
```
7179

72-
## lavaan 0.6-11 ended normally after 32 iterations
80+
## lavaan 0.6-19 ended normally after 32 iterations
7381
##
7482
## Estimator ML
7583
## Optimization method NLMINB
7684
## Number of model parameters 9
77-
##
85+
##
7886
## Number of observations 32
79-
##
87+
##
8088
## Model Test User Model:
8189
##
8290
## Test statistic 18.266
@@ -114,11 +122,10 @@ Then using that model fit object, simply call the `lavaanPlot` function,
114122
specifying your desired graph parameters.
115123

116124
``` r
117-
lavaanPlot(model = fit, node_options = list(shape = "box", fontname = "Helvetica"), edge_options = list(color = "grey"), coefs = F)
125+
lavaanPlot(model = fit, node_options = list(shape = "box", fontname = "Helvetica"), edge_options = list(color = "grey"), coefs = T)
118126
```
119127

120-
<div id="htmlwidget-8f7e74db38ea52a7f83d" style="width:672px;height:480px;" class="grViz html-widget"></div>
121-
<script type="application/json" data-for="htmlwidget-8f7e74db38ea52a7f83d">{"x":{"diagram":" digraph plot { \n graph [ overlap = true, fontsize = 10 ] \n node [ shape = box, fontname = Helvetica ] \n node [shape = box] \n cyl; disp; hp; wt; mpg; qsec \n node [shape = oval] \n \n \n edge [ color = grey ] \n cyl->mpg disp->mpg hp->mpg disp->qsec hp->qsec wt->qsec \n}","config":{"engine":"dot","options":null}},"evals":[],"jsHooks":[]}</script>
128+
![](README_files/figure-gfm/unnamed-chunk-3-1.png)<!-- -->
122129

123130
There is also functionality to save these plots as images and embed them
124131
in pdf output documents.
7.87 KB
Loading

0 commit comments

Comments
 (0)