Skip to content

Advance deprecation for pull_*() #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2025
Merged

Advance deprecation for pull_*() #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf6101b
advance deprecation to stop after 2 years
hfrick May 23, 2025
35a1c25
Update NEWS
hfrick May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

* Added a `collect_extracts()` method for workflow sets (#156).

* The deprecation of the `pull_*()` functions has been moved forward. These functions now error. Please use the `extract_*()` functions instead (#178).

* Increased the minimum required R version to R 4.1.

# workflowsets 1.1.0
Expand Down
30 changes: 3 additions & 27 deletions R/pull.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Extract elements from a workflow set
#'
#' `r lifecycle::badge("soft-deprecated")`
#' `r lifecycle::badge("deprecated")`
#'
#' `pull_workflow_set_result()` retrieves the results of [workflow_map()] for a
#' particular workflow while `pull_workflow()` extracts the unfitted workflow
Expand All @@ -15,41 +15,17 @@
#' @return `pull_workflow_set_result()` produces a `tune_result` or
#' `resample_results` object. `pull_workflow()` returns an unfit workflow
#' object.
#' @examples
#' library(tune)
#'
#' two_class_res
#'
#' pull_workflow_set_result(two_class_res, "none_cart")
#'
#' pull_workflow(two_class_res, "none_cart")
#' @export
pull_workflow_set_result <- function(x, id) {
lifecycle::deprecate_warn(
lifecycle::deprecate_stop(
"0.1.0",
"pull_workflow_set_result()",
"extract_workflow_set_result()"
)
if (length(id) != 1) {
cli::cli_abort("{.arg id} should have a single value.")
}
y <- x |> dplyr::filter(wflow_id == id[1])
if (nrow(y) != 1) {
cli::cli_abort("No workflow ID found for {.val {id[1]}}.")
}
y$result[[1]]
}

#' @export
#' @rdname pull_workflow_set_result
pull_workflow <- function(x, id) {
lifecycle::deprecate_warn("0.1.0", "pull_workflow()", "extract_workflow()")
if (length(id) != 1) {
cli::cli_abort("{.arg id} should have a single value.")
}
y <- x |> dplyr::filter(wflow_id == id[1])
if (nrow(y) != 1) {
cli::cli_abort("No workflow ID found for {.val {id[1]}}.")
}
y$info[[1]]$workflow[[1]]
lifecycle::deprecate_stop("0.1.0", "pull_workflow()", "extract_workflow()")
}
11 changes: 1 addition & 10 deletions man/pull_workflow_set_result.Rd
View file
Open in desktop

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

36 changes: 7 additions & 29 deletions tests/testthat/_snaps/pull.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,18 @@
# pulling objects
# pulling objects is deprecated

Code
res <- pull_workflow(car_set_1, "reg_lm")
pull_workflow_set_result(car_set_1, "reg_lm")
Condition
Warning:
`pull_workflow()` was deprecated in workflowsets 0.1.0.
i Please use `extract_workflow()` instead.

---

Code
res <- pull_workflow_set_result(car_set_1, "reg_lm")
Condition
Warning:
`pull_workflow_set_result()` was deprecated in workflowsets 0.1.0.
i Please use `extract_workflow_set_result()` instead.

---

Code
pull_workflow_set_result(car_set_1, "Gideon Nav")
Condition
Warning:
`pull_workflow_set_result()` was deprecated in workflowsets 0.1.0.
Error:
! `pull_workflow_set_result()` was deprecated in workflowsets 0.1.0 and is now defunct.
i Please use `extract_workflow_set_result()` instead.
Error in `pull_workflow_set_result()`:
! No workflow ID found for "Gideon Nav".

---

Code
pull_workflow(car_set_1, "Coronabeth Tridentarius")
pull_workflow(car_set_1, "reg_lm")
Condition
Warning:
`pull_workflow()` was deprecated in workflowsets 0.1.0.
Error:
! `pull_workflow()` was deprecated in workflowsets 0.1.0 and is now defunct.
i Please use `extract_workflow()` instead.
Error in `pull_workflow()`:
! No workflow ID found for "Coronabeth Tridentarius".

12 changes: 3 additions & 9 deletions tests/testthat/test-pull.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,13 @@ car_set_1 <-

# ------------------------------------------------------------------------------

test_that("pulling objects", {
expect_snapshot(res <- car_set_1 |> pull_workflow("reg_lm"))
expect_equal(res, car_set_1$info[[1]]$workflow[[1]])

expect_snapshot(res <- car_set_1 |> pull_workflow_set_result("reg_lm"))
expect_equal(res, car_set_1$result[[1]])

test_that("pulling objects is deprecated", {
expect_snapshot(
error = TRUE,
car_set_1 |> pull_workflow_set_result("Gideon Nav")
car_set_1 |> pull_workflow_set_result("reg_lm")
)
expect_snapshot(
error = TRUE,
car_set_1 |> pull_workflow("Coronabeth Tridentarius")
car_set_1 |> pull_workflow("reg_lm")
)
})