20230207 - attenuation and disattenuation of correlation due to measurement error

Author: isaactpetersen

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: petersenlab
 Type: Package
 Title: Package of R Functions for the Petersen Lab
-Version: 0.1.2-9013
+Version: 0.1.2-9014
 Authors@R: person("Isaac T.", "Petersen",
   email = "isaac-t-petersen@uiowa.edu",
   role = c("aut", "cre"), 

NAMESPACE

@@ -7,6 +7,7 @@ export(accuracyAtCutoff)
 export(accuracyAtEachCutoff)
 export(accuracyOverall)
 export(addText)
+export(attenuationCorrelation)
 export(columnBindFill)
 export(complement)
 export(convert.magic)
@@ -17,6 +18,7 @@ export(convertToSeconds)
 export(cor.table)
 export(crossTimeCorrelation)
 export(crossTimeCorrelationDF)
+export(disattenuationCorrelation)
 export(discriminationToFactorLoading)
 export(dropColsWithAllNA)
 export(dropRowsWithAllNA)

R/attenuationCorrelation.R

@@ -0,0 +1,35 @@
+#' @title
+#' Attenuation of True Correlation Due to Measurement Error.
+#'
+#' @description
+#' Estimate the observed association between the predictor and criterion after
+#' accounting for the degree to which a true correlation is attenuated due to
+#' measurement error.
+#'
+#' @details
+#' Estimate the association that would be observed between the predictor and
+#' criterion after accounting for the degree to which a true correlation is
+#' attenuated due to random measurement error (unreliability).
+#'
+#' @param trueAssociation Magnitude of true association (\emph{r} value).
+#' @param reliabilityOfPredictor Reliability of predictor (from 0 to 1).
+#' @param reliabilityOfCriterion Reliability of criterion/outcome (from 0 to 1).
+#'
+#' @return
+#' Observed correlation between predictor and criterion.
+#'
+#' @family correlation
+#'
+#' @export
+#'
+#' @examples
+#' attenuationCorrelation(
+#'   trueAssociation = .7,
+#'   reliabilityOfPredictor = .9,
+#'   reliabilityOfCriterion = .85)
+
+attenuationCorrelation <- function(trueAssociation, reliabilityOfPredictor, reliabilityOfCriterion){
+  observedAssociation <- trueAssociation * sqrt(reliabilityOfPredictor * reliabilityOfCriterion)
+
+  return(observedAssociation)
+}

R/disattenuationCorrelation.R

@@ -0,0 +1,36 @@
+#' @title
+#' Disattenuation of Observed Correlation Due to Measurement Error.
+#'
+#' @description
+#' Estimate the true association between the predictor and criterion after
+#' accounting for the degree to which a true correlation is attenuated due to
+#' measurement error.
+#'
+#' @details
+#' Estimate the true association between the predictor and criterion after
+#' accounting for the degree to which a true correlation is attenuated due to
+#' random measurement error (unreliability).
+#'
+#' @param observedAssociation Magnitude of observed association (\emph{r}
+#' value).
+#' @param reliabilityOfPredictor Reliability of predictor (from 0 to 1).
+#' @param reliabilityOfCriterion Reliability of criterion/outcome (from 0 to 1).
+#'
+#' @return
+#' True association between predictor and criterion.
+#'
+#' @family correlation
+#'
+#' @export
+#'
+#' @examples
+#' disattenuationCorrelation(
+#'   observedAssociation = .7,
+#'   reliabilityOfPredictor = .9,
+#'   reliabilityOfCriterion = .85)
+
+disattenuationCorrelation <- function(observedAssociation, reliabilityOfPredictor, reliabilityOfCriterion){
+  trueAssociation <- observedAssociation / sqrt(reliabilityOfPredictor * reliabilityOfCriterion)
+
+  return(trueAssociation)
+}

README.md

@@ -14,7 +14,7 @@ remotes::install_github("DevPsyLab/petersenlab")
 
 To obtain the citation for the `petersenlab` package, run `citation("petersenlab")`; the citation is:
 
-Petersen, I. T. (2023). *petersenlab: Package of R functions for the Petersen Lab*. R package version 0.1.2-9013. https://github.com/DevPsyLab/petersenlab, https://doi.org/10.5281/zenodo.7602890
+Petersen, I. T. (2023). *petersenlab: Package of R functions for the Petersen Lab*. R package version 0.1.2-9014. https://github.com/DevPsyLab/petersenlab, https://doi.org/10.5281/zenodo.7602890
 
 A `BibTeX` entry for `LaTeX` users is:
 ```
@@ -23,7 +23,7 @@ A `BibTeX` entry for `LaTeX` users is:
   title = {{petersenlab}: Package of {R} functions for the {Petersen Lab}},
   url = {https://github.com/DevPsyLab/petersenlab},
   doi = {10.5281/zenodo.7602890},
-  version = {0.1.2-9013},
+  version = {0.1.2-9014},
   date = {2022-03-23}
 }
 ```