diff --git a/README.Rmd b/README.Rmd index 372eb42..3c88c7f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -50,11 +50,15 @@ To use the `iccbeta` package, load it into _R_ using: library("iccbeta") ``` -From there, the `icc_beta()` function can be called to compute the -intraclass correlation: +From there, the `icc_beta()` function can be called using either `lmer()` +model object or individual components to compute the intraclass correlation: ```{r sample-call, eval = FALSE} -results = icc_beta(X, l2id, T, vy) +# Automatically calculate icc from model +results_model = icc_beta() + +# Calculate icc from individual terms. +results_manual = icc_beta(X, l2id, T, vy) ``` ## Authors diff --git a/README.md b/README.md index 4ddd3b8..7a51c54 100644 --- a/README.md +++ b/README.md @@ -45,11 +45,16 @@ To use the `iccbeta` package, load it into *R* using: library("iccbeta") ``` -From there, the `icc_beta()` function can be called to compute the -intraclass correlation: +From there, the `icc_beta()` function can be called using either +`lmer()` model object or individual components to compute the intraclass +correlation: ``` r -results = icc_beta(X, l2id, T, vy) +# Automatically calculate icc from model +results_model = icc_beta() + +# Calculate icc from individual terms. +results_manual = icc_beta(X, l2id, T, vy) ``` ## Authors