refactor: some renaming

DESCRIPTION

@@ -46,8 +46,8 @@ Collate:
     'MeasureDirectional.R'
     'PipeOpFcstLag.R'
     'PipeOpTargetTrafo.R'
-    'ResamplingForecastCV.R'
-    'ResamplingForecastHoldout.R'
+    'ResamplingFcstCV.R'
+    'ResamplingFcstHoldout.R'
     'TaskFcst.R'
     'TaskFcstAirpassengers.R'
     'TaskFcstElectricty.R'

NAMESPACE

@@ -13,8 +13,8 @@ export(LearnerFcstBats)
 export(LearnerFcstEts)
 export(LearnerFcstTbats)
 export(PipeOpFcstLag)
-export(ResamplingForecastCV)
-export(ResamplingForecastHoldout)
+export(ResamplingFcstCV)
+export(ResamplingFcstHoldout)
 export(TaskFcst)
 export(as_task_fcst)
 import(R6)

R/ResamplingForecastCV.R → R/ResamplingFcstCV.R

@@ -41,7 +41,7 @@
 #'
 #' # Internal storage:
 #' cv$instance #  list
-ResamplingForecastCV = R6Class("ResamplingForecastCV",
+ResamplingFcstCV = R6Class("ResamplingFcstCV",
   inherit = Resampling,
   public = list(
     #' @description
@@ -160,4 +160,4 @@ ResamplingForecastCV = R6Class("ResamplingForecastCV",
 )
 
 #' @include zzz.R
-register_resampling("forecast_cv", ResamplingForecastCV)
+register_resampling("forecast_cv", ResamplingFcstCV)

R/ResamplingForecastHoldout.R → R/ResamplingFcstHoldout.R

@@ -38,7 +38,7 @@
 #'
 #' # Internal storage:
 #' holdout$instance # simple list
-ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
+ResamplingFcstHoldout = R6Class("ResamplingFcstHoldout",
   inherit = Resampling,
   public = list(
     #' @description
@@ -67,7 +67,7 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
   ),
 
   private = list(
-    .sample_old = function(ids, ...) {
+    .sample = function(ids, task, ...) {
       if ("ordered" %nin% task$properties) {
         stopf(
           "Resampling '%s' requires an ordered task, but Task '%s' has no order.",
@@ -78,7 +78,7 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
       pars = self$param_set$get_values()
       ratio = pars$ratio
       n = pars$n
-      n_obs = length(ids)
+      n_obs = task$nrow
 
       has_ratio = !is.null(ratio)
       if (!xor(!has_ratio, is.null(n))) {
@@ -92,12 +92,30 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
         nr = max(n_obs + n, 0L)
       }
 
-      ids = sort(ids)
-      ii = ids[1:nr]
-      list(train = ii, test = ids[(nr + 1L):n_obs])
+      order_cols = task$col_roles$order
+      key_cols = task$col_roles$key
+      has_key_cols = length(key_cols) > 0L
+      tab = task$backend$data(rows = ids, cols = c(task$backend$primary_key, order_cols, key_cols))
+      if (has_key_cols) {
+        setnames(tab, c("row_id", "order", "key"))
+        setorderv(tab, c("key", "order"))
+        n_groups = length(unique(tab$key))
+        nr = if (has_ratio) nr %/% n_groups else nr
+        list(
+          train = tab[, .SD[1:nr], by = key][, row_id],
+          test = tab[, .SD[(nr + 1L):.N], by = key][, row_id]
+        )
+      } else {
+        setnames(tab, c("row_id", "order"))
+        setorderv(tab, c("order"))
+        list(
+          train = tab[1:nr, row_id],
+          test = tab[(nr + 1L):.N, row_id]
+        )
+      }
     },
 
-    .sample = function(ids, task, ...) {
+    .sample_ids = function(ids, ...) {
       if ("ordered" %nin% task$properties) {
         stopf(
           "Resampling '%s' requires an ordered task, but Task '%s' has no order.",
@@ -108,7 +126,7 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
       pars = self$param_set$get_values()
       ratio = pars$ratio
       n = pars$n
-      n_obs = task$nrow
+      n_obs = length(ids)
 
       has_ratio = !is.null(ratio)
       if (!xor(!has_ratio, is.null(n))) {
@@ -122,27 +140,9 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
         nr = max(n_obs + n, 0L)
       }
 
-      order_cols = task$col_roles$order
-      key_cols = task$col_roles$key
-      has_key_cols = length(key_cols) > 0L
-      tab = task$backend$data(rows = ids, cols = c(task$backend$primary_key, order_cols, key_cols))
-      if (has_key_cols) {
-        setnames(tab, c("row_id", "order", "key"))
-        setorderv(tab, c("key", "order"))
-        n_groups = length(unique(tab$key))
-        nr = if (has_ratio) nr %/% n_groups else nr
-        list(
-          train = tab[, .SD[1:nr], by = key][, row_id],
-          test = tab[, .SD[(nr + 1L):.N], by = key][, row_id]
-        )
-      } else {
-        setnames(tab, c("row_id", "order"))
-        setorderv(tab, c("order"))
-        list(
-          train = tab[1:nr, row_id],
-          test = tab[(nr + 1L):.N, row_id]
-        )
-      }
+      ids = sort(ids)
+      ii = ids[1:nr]
+      list(train = ii, test = ids[(nr + 1L):n_obs])
     },
 
     .get_train = function(i) {
@@ -160,4 +160,4 @@ ResamplingForecastHoldout = R6Class("ResamplingForecastHoldout",
 )
 
 #' @include zzz.R
-register_resampling("forecast_holdout", ResamplingForecastHoldout)
+register_resampling("forecast_holdout", ResamplingFcstHoldout)

R/TaskFcstAirpassengers.R

@@ -14,9 +14,7 @@
 NULL
 
 load_task_airpassengers = function(id = "airpassengers") {
-  if (!requireNamespace("tsbox", quietly = TRUE)) {
-    stopf("Package 'tsbox' is required to load the 'AirPassengers' dataset.")
-  }
+  require_namespaces("tsbox")
   dt = tsbox::ts_dt(load_dataset("AirPassengers", "datasets"))
   setnames(dt, c("date", "passengers"))
   b = as_data_backend(dt)

R/TaskFcstElectricty.R

@@ -14,9 +14,7 @@
 NULL
 
 load_task_electricty = function(id = "electricity") {
-  if (!requireNamespace("tsibbledata", quietly = TRUE)) {
-    stopf("Package 'tsibbledata' is required to load the 'vic_elec' dataset.")
-  }
+  require_namespaces("tsibbledata")
   dt = as.data.table(load_dataset("vic_elec", "tsibbledata"))
   setnames(dt, tolower)
   demand = temperature = holiday = NULL

R/TaskFcstLivestock.R

@@ -14,9 +14,7 @@
 NULL
 
 load_task_livestock = function(id = "livestock") {
-  if (!requireNamespace("tsibbledata", quietly = TRUE)) {
-    stopf("Package 'tsibbledata' is required to load the 'aus_livestock' dataset.")
-  }
+  require_namespaces(c("tsibbledata", "tsibble"))
   dt = as.data.table(load_dataset("aus_livestock", "tsibbledata"))
   setnames(dt, tolower)
   dt[, month := as.Date(month)]

tests/testthat/test_ResamplingForecastHoldout.R → tests/testthat/test_ResamplingFcstHoldout.R

@@ -1,7 +1,6 @@
 test_that("forecast_holdout basic properties", {
-  skip("currently require datetime column, i.e. don't sort based on ids")
-  task = tsk("penguins")
-  resampling = rsmp("forecast_holdout", ratio = 0.7)
+  task = tsk("airpassengers")
+  resampling = rsmp("forecast_holdout", ratio = 0.8)
   expect_resampling(resampling, task)
   resampling$instantiate(task)
   expect_resampling(resampling, task)