/
README.Rmd
64 lines (39 loc) · 3.55 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# semEff
<!-- badges: start -->
[](https://www.repostatus.org/) [](https://lifecycle.r-lib.org/articles/stages.html) [](https://www.gnu.org/licenses/gpl-3.0.en.html)  [](https://github.com/murphymv/semEff/actions)
[](https://CRAN.R-project.org/package=semEff)  
[](https://paypal.me/murphymv1)
<!-- badges: end -->
`semEff` provides functionality to automatically calculate direct, indirect, and total effects for 'piecewise' structural equation models, comprising lists of fitted models representing structured equations (Lefcheck, 2016; Shipley, 2000, 2009). Confidence intervals are provided via bootstrapping.
Currently supported model classes are `"lm"`, `"glm"`, `"lmerMod"`, `"glmerMod"`, `"lmerModLmerTest"`, `"gls"`, and `"betareg"`.
## Installation
You can install the released version of `semEff` from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("semEff")
```
And the development version from [GitHub](https://github.com/) with:
``` r
devtools::install_github("murphymv/semEff@dev")
```
## Usage
The primary function is [`semEff()`](https://murphymv.github.io/semEff/reference/semEff.html), which returns an object of class `"semEff"` with associated `print()` and `summary()` methods. Everything can technically be accomplished in a single call to `semEff()`; however, since bootstrapping is employed to generate resamples for confidence intervals (via [`bootEff()`](https://murphymv.github.io/semEff/reference/bootEff.html)), it is usually preferable to save these estimates separately prior to calling `semEff()` -- allowing more flexibility and saving time if/when recalling the function.
## Examples
Package functions are well-documented and most include some short examples. In addition, see the following vignettes for some longer demonstrations:
- [Analysing direct vs. indirect effects of landscape location on plant species richness](https://murphymv.github.io/semEff/articles/semEff.html)
- [Predicting and plotting indirect effects of degree days to bud burst on tree growth](https://murphymv.github.io/semEff/articles/predicting-effects.html)
## References
Lefcheck, J. S. (2016). piecewiseSEM: Piecewise structural equation modelling in R for ecology, evolution, and systematics. *Methods in Ecology and Evolution*, *7*(5), 573--579. <https://doi.org/10/f8s8rb>
Shipley, B. (2000). A New Inferential Test for Path Models Based on Directed Acyclic Graphs. *Structural Equation Modeling: A Multidisciplinary Journal*, *7*(2), 206--218. <https://doi.org/10/cqm32d>
Shipley, B. (2009). Confirmatory path analysis in a generalized multilevel context. *Ecology*, *90*(2), 363--368. <https://doi.org/10/bqd43d>