From 82dc9e275afb4b8c7520f791cff9d1ac1cc9a16f Mon Sep 17 00:00:00 2001 From: James Balamuta Date: Mon, 28 Jan 2019 14:33:29 -0600 Subject: [PATCH] Update the README once more... --- README.Rmd | 7 ++++--- README.md | 8 ++++---- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.Rmd b/README.Rmd index 3c88c7f..3da0489 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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() # Calculate icc from individual terms. -results_manual = icc_beta(X, l2id, T, vy) +results_component = icc_beta(X, l2id, T, vy) ``` ## Authors diff --git a/README.md b/README.md index 7a51c54..e8f451d 100644 --- a/README.md +++ b/README.md @@ -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() # Calculate icc from individual terms. -results_manual = icc_beta(X, l2id, T, vy) +results_component = icc_beta(X, l2id, T, vy) ``` ## Authors