Add required_pkgs() methods to all conformal interval methods (#190)

Author: EmilHvitfeldt

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: probably
 Title: Tools for Post-Processing Predicted Values
-Version: 1.1.1.9000
+Version: 1.1.1.9001
 Authors@R: c(
     person("Max", "Kuhn", , "[email protected]", role = c("aut", "cre")),
     person("Davis", "Vaughan", , "[email protected]", role = "aut"),

NAMESPACE

@@ -126,6 +126,10 @@ S3method(required_pkgs,cal_estimate_multinomial)
 S3method(required_pkgs,cal_estimate_multinomial_spline)
 S3method(required_pkgs,cal_estimate_none)
 S3method(required_pkgs,cal_object)
+S3method(required_pkgs,int_conformal_cv)
+S3method(required_pkgs,int_conformal_full)
+S3method(required_pkgs,int_conformal_quantile)
+S3method(required_pkgs,int_conformal_split)
 S3method(threshold_perf,data.frame)
 S3method(type_sum,cal_object)
 S3method(vec_cast,character.class_pred)

NEWS.md

@@ -1,5 +1,7 @@
 # probably (development version)
 
+* Add `required_pkgs()` methods to `int_conformal_cv()`, `int_conformal_full()`, `int_conformal_quantile()`,  and `int_conformal_split()`. (#190)
+
 # probably 1.1.1
 
 * Updated unit tests for new ggplot2 release (#180).

R/conformal_infer.R

@@ -113,6 +113,20 @@ print.int_conformal_full <- function(x, ...) {
   invisible(x)
 }
 
+#' @rdname required_pkgs.int_conformal_cv
+#' @keywords internal
+#' @export
+required_pkgs.int_conformal_full <- function(x, infra = TRUE, ...) {
+  model_pkgs <- required_pkgs(x$wflow, infra = infra)
+
+  if (infra) {
+    model_pkgs <- c(model_pkgs, "probably")
+  }
+  
+  model_pkgs <- unique(model_pkgs)
+  model_pkgs
+}
+
 # ------------------------------------------------------------------------------
 
 #' Prediction intervals from conformal methods

R/conformal_infer_cv.R

@@ -148,6 +148,23 @@ print.int_conformal_cv <- function(x, ...) {
   invisible(x)
 }
 
+#' S3 methods to track which additional packages are needed for prediction 
+#' intervals via conformal inference
+#' @param x a conformal interval object
+#' @inheritParams generics::required_pkgs
+#' @export
+required_pkgs.int_conformal_cv <- function(x, infra = TRUE, ...) {
+  model_pkgs <- map(x$models, required_pkgs, infra = infra)
+  model_pkgs <- unlist(model_pkgs)
+  
+  if (infra) {
+    model_pkgs <- c(model_pkgs, "probably")
+  }
+  
+  model_pkgs <- unique(model_pkgs)
+  model_pkgs
+}
+
 # ------------------------------------------------------------------------------
 # helpers
 

R/conformal_infer_quantile.R

@@ -115,6 +115,20 @@ print.int_conformal_quantile <- function(x, ...) {
   invisible(x)
 }
 
+#' @rdname required_pkgs.int_conformal_cv
+#' @keywords internal
+#' @export
+required_pkgs.int_conformal_quantile <- function(x, infra = TRUE, ...) {
+  model_pkgs <- required_pkgs(x$wflow, infra = infra)
+
+  if (infra) {
+    model_pkgs <- c(model_pkgs, "probably")
+  }
+  
+  model_pkgs <- unique(model_pkgs)
+  model_pkgs
+}
+
 #' @export
 #' @rdname predict.int_conformal_full
 predict.int_conformal_quantile <- function(object, new_data, ...) {

R/conformal_infer_split.R

@@ -94,6 +94,20 @@ print.int_conformal_split <- function(x, ...) {
   invisible(x)
 }
 
+#' @rdname required_pkgs.int_conformal_cv
+#' @keywords internal
+#' @export
+required_pkgs.int_conformal_split <- function(x, infra = TRUE, ...) {
+  model_pkgs <- required_pkgs(x$wflow, infra = infra)
+
+  if (infra) {
+    model_pkgs <- c(model_pkgs, "probably")
+  }
+  
+  model_pkgs <- unique(model_pkgs)
+  model_pkgs
+}
+
 #' @export
 #' @rdname predict.int_conformal_full
 predict.int_conformal_split <- function(object, new_data, level = 0.95, ...) {

man/int_conformal_full.Rd

@@ -63,4 +63,13 @@ test_that("split conformal quantile intervals", {
     nrow(new_int),
     nrow(sim_new)
   )
+
+  expect_identical(
+    required_pkgs(lm_int),
+    c(required_pkgs(lm_int$wflow), "probably")
+  )
+  expect_identical(
+    required_pkgs(lm_int, infra = FALSE),
+    required_pkgs(lm_int$wflow, infra = FALSE)
+  )
 })