Add lifting accessor function for Lin's CCC

- new function getLiftCCC()
- accesses the lifting correlations between
  SomaScan versions for each analyte
- fixed small bug with SomaReadr reference
  in params.R
- closes SomaLogic#88

NAMESPACE

@@ -78,6 +78,7 @@ export(getAnalyteInfo)
 export(getAnalytes)
 export(getFeatureData)
 export(getFeatures)
+export(getLiftCCC)
 export(getMeta)
 export(getSeqId)
 export(getSeqIdMatches)

R/getLiftCCC.R

@@ -0,0 +1,27 @@
+#' Access Lin's Concordance Correlation Coefficient for SomaScan
+#'
+#' Access the CCC between various SomaScan versions.\cr
+#' \cr
+#' Table of SomaScan Assay versions:
+#' \tabular{lll}{
+#'   **Version**  \tab **Commercial Name** \tab **Size** \cr
+#'   `V4`         \tab 5k                  \tab 5284     \cr
+#'   `v4.1`       \tab 7k                  \tab 7596     \cr
+#'   `v5.0`       \tab 11k                 \tab 11083    \cr
+#' }
+#'
+#' @inheritParams params
+#' @return A tibble of either the `serum` or `plasma` CCC
+#'   between various versions of the SomaScan assay.
+#' @author Stu Field
+#' @examples
+#' # plasma (default)
+#' getLiftCCC()
+#'
+#' # serum
+#' getLiftCCC("serum")
+#' @export
+getLiftCCC <- function(matrix = c("plasma", "serum")) {
+  matrix <- match.arg(matrix)
+  dplyr::select(lift_master, SeqId, starts_with(matrix) & ends_with("ccc"))
+}

R/params.R

@@ -1,7 +1,7 @@
-#' Common Parameters in \pkg{SomaReadr}
+#' Common Parameters in \pkg{SomaDataIO}
 #'
 #' The parameters below are commonly used throughout
-#'   the \pkg{SomaReadr} package.
+#'   the \pkg{SomaDataIO} package.
 #'
 #' @name params
 #'
@@ -11,5 +11,8 @@
 #' @param x A `soma_adat` object (with intact attributes),
 #'   typically created using [read_adat()].
 #'
+#' @param matrix Character. A string of (usually) either 
+#'   `"serum"` or `"plasma"`.
+#'
 #' @return A `soma_adat` class object.
 NULL