rename cookfarm_sample task to cookfarm_mlr3

mlr-org · Jun 2, 2022 · e9cfa5a · e9cfa5a
1 parent 6792a5c
commit e9cfa5a
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 18 deletions.
diff --git a/R/Task_regr_cookfarm_profiles.R b/R/Task_regr_cookfarm_profiles.R
@@ -1,7 +1,7 @@
 #' @title Cookfarm Profiles Regression Task
 #'
 #' @docType data
-#' @usage data(cookfarm_sample)
+#' @usage data(cookfarm_mlr3)
 #' @name mlr_tasks_cookfarm
 #' @format [R6::R6Class] inheriting from [TaskRegr].
 #'
@@ -47,10 +47,10 @@
 #' modeling the spatial and temporal variation of soil moisture in a dryland
 #' agricultural field. Submitted to Water Resources Research.
 #' @template seealso_task
-"cookfarm_sample"
+"cookfarm_mlr3"
 
 load_task_cookfarm = function(id = "cookfarm") {
-  b = mlr3::as_data_backend(cookfarm_sample)
+  b = mlr3::as_data_backend(cookfarm_mlr3)
   b$hash = "_mlr3_tasks_cookfarm_"
   task = TaskRegrST$new(
     id = "cookfarm", b, target = "PHIHOX",

diff --git a/R/as_task_regr_st.R b/R/as_task_regr_st.R
@@ -23,16 +23,16 @@
 #' @examples
 #' if (mlr3misc::require_namespaces(c("sf"), quietly = TRUE)) {
 #'   library("mlr3")
-#'   data("cookfarm_sample", package = "mlr3spatiotempcv")
+#'   data("cookfarm_mlr3", package = "mlr3spatiotempcv")
 #'
 #'   # data.frame
-#'   as_task_regr_st(cookfarm_sample, target = "PHIHOX",
+#'   as_task_regr_st(cookfarm_mlr3, target = "PHIHOX",
 #'     coords_as_features = FALSE,
 #'     crs = 26911,
 #'     coordinate_names = c("x", "y"))
 #'
 #'   # sf
-#'   cookfarm_sf = sf::st_as_sf(cookfarm_sample, coords = c("x", "y"), crs = 26911)
+#'   cookfarm_sf = sf::st_as_sf(cookfarm_mlr3, coords = c("x", "y"), crs = 26911)
 #'   as_task_regr_st(cookfarm_sf, target = "PHIHOX")
 #'
 #'   # TaskRegrST

diff --git a/R/zzz.R b/R/zzz.R
@@ -40,7 +40,7 @@
 "_PACKAGE"
 
 utils::globalVariables(c(
-  "row_id", "cookfarm_sample", "ecuador", "diplodia",
+  "row_id", "cookfarm_mlr3", "ecuador", "diplodia",
   "resampling", "task", "indicator", "fold", "id", "type",
   "fold_space", "fold_time"))
 

diff --git a/data-raw/cookfarm_mlr3.R b/data-raw/cookfarm_mlr3.R
@@ -1,4 +1,4 @@
-## code to prepare `cookfarm_sample` dataset goes here
+## code to prepare `cookfarm_mlr3` dataset goes here
 
 # retrieved from package https://github.com/envirometrix/landmap after GSIF was archived on CRAN in 2021-03
 set.seed(42)

diff --git a/data/cookfarm_sample.rda b/data/cookfarm_sample.rda
diff --git a/man/as_task_regr_st.Rd b/man/as_task_regr_st.Rd
diff --git a/man/mlr_tasks_cookfarm.Rd b/man/mlr_tasks_cookfarm.Rd
diff --git a/tests/testthat/test-1-autoplot.R b/tests/testthat/test-1-autoplot.R
@@ -461,7 +461,7 @@ test_that("autoplot time + space", {
   skip_if_not_installed("patchwork")
   skip_if_not_installed("ggtext")
   # special data with five temporal levels
-  data = cookfarm_sample
+  data = cookfarm_mlr3
   b = mlr3::as_data_backend(data)
   b$hash = "_mlr3_tasks_cookfarm_"
   task = TaskRegrST$new(

diff --git a/tests/testthat/test-as_task.R b/tests/testthat/test-as_task.R
@@ -38,8 +38,8 @@ test_that("as_task_regr_st.TaskRegrST works", {
 })
 
 test_that("as_task_regr_st.data.rame works", {
-  data("cookfarm_sample", package = "mlr3spatiotempcv")
-  new_task = as_task_regr_st(cookfarm_sample, target = "PHIHOX",
+  data("cookfarm_mlr3", package = "mlr3spatiotempcv")
+  new_task = as_task_regr_st(cookfarm_mlr3, target = "PHIHOX",
     id = "cookfarm",
     coords_as_features = FALSE,
     crs = 26911,
@@ -50,8 +50,8 @@ test_that("as_task_regr_st.data.rame works", {
 
 test_that("as_task_regr_st.sf works", {
   skip_if_not_installed("sf")
-  data("cookfarm_sample", package = "mlr3spatiotempcv")
-  cookfarm_sf = sf::st_as_sf(cookfarm_sample, coords = c("x", "y"), crs = 26911)
+  data("cookfarm_mlr3", package = "mlr3spatiotempcv")
+  cookfarm_sf = sf::st_as_sf(cookfarm_mlr3, coords = c("x", "y"), crs = 26911)
   new_task = as_task_regr_st(cookfarm_sf, target = "PHIHOX")
 
   expect_class(new_task, "TaskRegrST")