Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
arcaldwell49 committed May 4, 2021
1 parent aabe3a0 commit 5fef5c5
Show file tree
Hide file tree
Showing 15 changed files with 91 additions and 90 deletions.
38 changes: 18 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ Status](https://travis-ci.com/arcaldwell49/SimplyAgree.svg?branch=master)](https
[![Codecov test
coverage](https://codecov.io/gh/arcaldwell49/SimplyAgree/branch/master/graph/badge.svg)](https://codecov.io/gh/arcaldwell49/SimplyAgree?branch=master)

**This Package is still in development and has only recently implemented
basic unit tests. USE WITH CAUTION**

This is a R package for calculating absolute agreement and estimating
the required sample size for a study attempting to estimate absolute
agreement.
`SimplyAgree` is an R package, and [jamovi](https://www.jamovi.org/)
module, created to make agreement and reliability analyses easier for
the average researcher. The functions within this package include simple
tests of agreement (`agree_test`), agreement analysis for nested
(`agree_nest`) and replicate data (`agree_reps`), and provide robust
analyses of reliability (`reli_stats`). In addition, this package
contains a set of functions to help when planning studies looking to
assess measurement agreement (`blandPowerCurve`).

## Installing SimplyAgree

Expand All @@ -35,12 +37,10 @@ quantitative measurements: Exact test procedure and sample size
calculation. *Statistics in Biopharmaceutical Research*, 1-8.
<https://doi.org/10.1080/19466315.2019.1677495>

Parker, R. A., Weir, C. J., Rubio, N., Rabinovich, R., Pinnock, H.,
Hanley, J., McLoughan, L., Drost, E.M., Mantoani, L.C., MacNee, W., &
McKinstry, B. (2016). Application of mixed effects limits of agreement
in the presence of multiple sources of variability: exemplar from the
comparison of several devices to measure respiratory rate in COPD
patients. Plos one, 11(12), e0168321.
Parker, R. A., et al (2016). Application of mixed effects limits of
agreement in the presence of multiple sources of variability: exemplar
from the comparison of several devices to measure respiratory rate in
COPD patients. Plos one, 11(12), e0168321.
<https://doi.org/10.1371/journal.pone.0168321>

Zou, G. Y. (2013). Confidence interval estimation for the Bland–Altman
Expand All @@ -53,21 +53,19 @@ intraclass correlation coefficient and the SEM. *The Journal of Strength
& Conditioning Research*, 19(1),
231-240.<https://doi.org/10.1519/15184.1>

Lu, Meng-Jie, Zhong, Wei-Hua, Liu, Yu-Xiu, Miao, Hua-Zhang, Li,
Yong-Chang and Ji, Mu-Huo. “Sample Size for Assessing Agreement between
Lu, Meng-Jie, et al (2016). “Sample Size for Assessing Agreement between
Two Methods of Measurement by Bland−Altman Method” *The International
Journal of Biostatistics*, vol. 12, no. 2, 2016.
Journal of Biostatistics*, 12(2),
<https://doi.org/10.1515/ijb-2015-0039>

King, TS and Chinchilli, VM. (2001). A generalized concordance
correlation coefficient for continuous and categorical data. *Statistics
in Medicine*, 20, 2131:2147.

King, TS; Chinchilli, VM; Carrasco, JL. (2007). A repeated measures
King, TS, Chinchilli, VM, and Carrasco, JL. (2007). A repeated measures
concordance correlation coefficient. *Statistics in Medicine*, 26,
3095:3113.

Carrasco, JL; Phillips, BR; Puig-Martinez, J; King, TS; Chinchilli, VM.
(2013). Estimation of the concordance correlation coefficient for
repeated measures using SAS and R. *Computer Methods and Programs in
Biomedicine*, 109, 293-304.
Carrasco, JL, et al. (2013). Estimation of the concordance correlation
coefficient for repeated measures using SAS and R. *Computer Methods and
Programs in Biomedicine*, 109, 293-304.
2 changes: 1 addition & 1 deletion docs/articles/intro_vignette.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/articles/reanalysis.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 6 additions & 7 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ pkgdown_sha: ~
articles:
intro_vignette: intro_vignette.html
reanalysis: reanalysis.html
last_built: 2021-05-04T18:15Z
last_built: 2021-05-04T22:20Z

19 changes: 16 additions & 3 deletions docs/reference/agree_nest.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 16 additions & 3 deletions docs/reference/agree_reps.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion docs/reference/blandPowerCurve.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 5fef5c5

Please sign in to comment.