Replace tsk("boston_housing") with tsk("ames_housing")

mlr-org · Nov 4, 2024 · a9ce0f0 · a9ce0f0
1 parent f2fe89f
commit a9ce0f0
Show file tree

Hide file tree

Showing 39 changed files with 192 additions and 180 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -156,7 +156,7 @@ Collate:
     'TaskGeneratorSpirals.R'
     'TaskGeneratorXor.R'
     'TaskRegr.R'
-    'TaskRegr_boston_housing.R'
+    'TaskRegr_ames_housing.R'
     'TaskRegr_mtcars.R'
     'TaskUnsupervised.R'
     'as_benchmark_result.R'

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,7 @@
 # mlr3 (development version)
 
 * fix: Quantiles must not ascend with probabilities.
+* refactor: Replace `tsk("boston_housing")` with `tsk("ames_housing")`.
 
 # mlr3 0.21.1
 

diff --git a/R/PredictionRegr.R b/R/PredictionRegr.R
@@ -10,7 +10,7 @@
 #' @template seealso_prediction
 #' @export
 #' @examples
-#' task = tsk("boston_housing")
+#' task = tsk("ames_housing")
 #' learner = lrn("regr.featureless", predict_type = "se")
 #' p = learner$train(task)$predict(task)
 #' p$predict_types

diff --git a/R/Task.R b/R/Task.R
@@ -16,7 +16,7 @@
 #'    For example, for a classification task a single column must be marked as target column, and others as features.
 #'
 #' Predefined (toy) tasks are stored in the [dictionary][mlr3misc::Dictionary] [mlr_tasks],
-#' e.g. [`penguins`][mlr_tasks_penguins] or [`boston_housing`][mlr_tasks_boston_housing].
+#' e.g. [`penguins`][mlr_tasks_penguins] or [`ames_housing`][mlr_tasks_ames_housing].
 #' More toy tasks can be found in the dictionary after loading \CRANpkg{mlr3data}.
 #'
 #' @template param_id

diff --git a/R/TaskRegr_ames_housing.R b/R/TaskRegr_ames_housing.R
@@ -0,0 +1,35 @@
+#' @title House Sales in Ames, Iowa
+#'
+#' @name ames_housing
+#' @format [R6::R6Class] inheriting from [TaskRegr].
+#' @aliases mlr_tasks_ames_housing
+#'
+#' @description
+#' A regression task to predict house sale prices for Ames, Iowa.
+#' This is the processed version from the [AmesHousing::make_ames()] package.
+#'
+#' Contains 80 features and 2930 observations.
+#' Target column is `"Sale_Price"`.
+#'
+#' @section Construction:
+#' ```
+#' mlr_tasks$get("ames_housing")
+#' tsk("ames_housing")
+#' ```
+#'
+#' @section Meta Information:
+#' `r rd_info(tsk("ames_housing"))`
+#'
+#' @template seealso_task
+NULL
+
+load_task_ames_housing = function(id = "ames_housing") {
+  b = as_data_backend(readRDS(system.file("extdata", "ames_housing.rds", package = "mlr3")))
+  task = mlr3::TaskRegr$new(id, b, target = "Sale_Price", label = "Ames House Sales")
+  b$hash = task$man = "mlr3::mlr_tasks_ames_housing"
+  task
+}
+
+#' @include mlr_tasks.R
+mlr_tasks$add("ames_housing", load_task_ames_housing)
+
diff --git a/R/TaskRegr_boston_housing.R b/R/TaskRegr_boston_housing.R
diff --git a/R/partition.R b/R/partition.R
@@ -12,7 +12,7 @@
 #' @export
 #' @examples
 #' # regression task partitioned into training and test set
-#' task = tsk("boston_housing")
+#' task = tsk("ames_housing")
 #' split = partition(task, ratio = 0.5)
 #' data = data.frame(
 #'   y = c(task$truth(split$train), task$truth(split$test)),

diff --git a/inst/extdata/ames_housing.R b/inst/extdata/ames_housing.R
@@ -0,0 +1,3 @@
+root = rprojroot::find_package_root_file()
+data = setDT(AmesHousing::make_ames())
+saveRDS(data, file = file.path(root, "inst", "extdata", "ames_housing.rds"), version = 2L)
diff --git a/inst/extdata/ames_housing.rds b/inst/extdata/ames_housing.rds
diff --git a/man/PredictionRegr.Rd b/man/PredictionRegr.Rd
diff --git a/man/Task.Rd b/man/Task.Rd
diff --git a/man/TaskClassif.Rd b/man/TaskClassif.Rd
diff --git a/man/TaskRegr.Rd b/man/TaskRegr.Rd
diff --git a/man/TaskSupervised.Rd b/man/TaskSupervised.Rd
diff --git a/man/TaskUnsupervised.Rd b/man/TaskUnsupervised.Rd
diff --git a/man/ames_housing.Rd b/man/ames_housing.Rd
diff --git a/man/mlr_tasks.Rd b/man/mlr_tasks.Rd
diff --git a/man/mlr_tasks_boston_housing.Rd b/man/mlr_tasks_boston_housing.Rd
diff --git a/man/mlr_tasks_breast_cancer.Rd b/man/mlr_tasks_breast_cancer.Rd
diff --git a/man/mlr_tasks_german_credit.Rd b/man/mlr_tasks_german_credit.Rd
diff --git a/man/mlr_tasks_iris.Rd b/man/mlr_tasks_iris.Rd
diff --git a/man/mlr_tasks_mtcars.Rd b/man/mlr_tasks_mtcars.Rd
diff --git a/man/mlr_tasks_penguins.Rd b/man/mlr_tasks_penguins.Rd
diff --git a/man/mlr_tasks_pima.Rd b/man/mlr_tasks_pima.Rd