Skip to content

Commit

Permalink
Update the README once more...
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Jan 28, 2019
1 parent ea6ed6d commit 82dc9e2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
7 changes: 4 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,16 @@ To use the `iccbeta` package, load it into _R_ using:
library("iccbeta")
```

From there, the `icc_beta()` function can be called using either `lmer()`
model object or individual components to compute the intraclass correlation:
From there, calling the `icc_beta()` function with either a `lmer()`
model object or the desired individual components will
compute the intraclass correlation:

```{r sample-call, eval = FALSE}
# Automatically calculate icc from model
results_model = icc_beta(<lmer-model>)
# Calculate icc from individual terms.
results_manual = icc_beta(X, l2id, T, vy)
results_component = icc_beta(X, l2id, T, vy)
```

## Authors
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ To use the `iccbeta` package, load it into *R* using:
library("iccbeta")
```

From there, the `icc_beta()` function can be called using either
`lmer()` model object or individual components to compute the intraclass
correlation:
From there, calling the `icc_beta()` function with either a `lmer()`
model object or the desired individual components will compute the
intraclass correlation:

``` r
# Automatically calculate icc from model
results_model = icc_beta(<lmer-model>)

# Calculate icc from individual terms.
results_manual = icc_beta(X, l2id, T, vy)
results_component = icc_beta(X, l2id, T, vy)
```

## Authors
Expand Down

0 comments on commit 82dc9e2

Please sign in to comment.