Merge pull request #331 from billdenney/getGroups.PKNCAdata_derivation

The creation of `getGroups.PKNCAdata` for use within PKNCA

NAMESPACE

@@ -39,6 +39,7 @@ S3method(getDataName,PKNCAresults)
 S3method(getDepVar,PKNCAconc)
 S3method(getDepVar,PKNCAdose)
 S3method(getGroups,PKNCAconc)
+S3method(getGroups,PKNCAdata)
 S3method(getGroups,PKNCAdose)
 S3method(getGroups,PKNCAresults)
 S3method(getIndepVar,PKNCAconc)

NEWS.md

@@ -5,7 +5,7 @@ the inclusion of IV NCA parameters and additional specifications of
 the dosing including dose amount and route.
 
 # PKNCA 0.11.0.9000
-
+* PKNCA now contains a `getGroups.PKNCAdata` function to capture grouping columns.
 * Duplicate data checks now account for excluded rows.  So, if a row is
   duplicated and all but one of the duplicated rows is excluded, it is not an
   error.  (#298)

R/class-PKNCAdata.R

@@ -226,3 +226,15 @@ print.PKNCAdata <- function(x, ...) {
 summary.PKNCAdata <- function(object, ...) {
   print.PKNCAdata(object, summarize=TRUE, ...)
 }
+
+#' Get the groups (right hand side after the `|` from a PKNCA
+#' object).
+#' 
+#' @rdname getGroups.PKNCAconc
+#' @param object The object to extract the data from
+#' @param ... Arguments passed to other getGroups functions
+#' @returns A data frame with the (selected) group columns.
+#' @export
+getGroups.PKNCAdata <- function(object, ...) {
+  getGroups(as_PKNCAconc(object), ...)
+}

tests/testthat/test-class-PKNCAdata.R

@@ -335,3 +335,17 @@ test_that("intervals may be a tibble", {
     as.data.frame(pk.nca(mydata))
   )
 })
+
+test_that("getGroups works", {
+  # Check that it works with grouping [contains only the grouping column(s)]
+  o_conc_group <- PKNCAconc(as.data.frame(datasets::Theoph), conc~Time|Subject)
+  data_group <- as.data.frame(datasets::Theoph)
+  expected_group <- data.frame(Subject = data_group$Subject)
+
+  expect_equal(getGroups.PKNCAdata(o_conc_group), expected_group)
+
+  # Check that it works without groupings as expected [empty]
+  o_conc_nongroup <- PKNCAconc(as.data.frame(datasets::Theoph)[datasets::Theoph$Subject == 1,], conc~Time)
+
+  expect_equal(names(getGroups.PKNCAdata(o_conc_nongroup)), character(0))
+})