X-Git-Url: https://git.auder.net/variants/Baroque/complete_rules.html?a=blobdiff_plain;f=pkg%2FR%2FForecaster.R;h=da8579b7312bfcc520d8e2a8504202bb68ff2cbd;hb=63ff1ecbd80adfe347faa0d954f526d15f033c22;hp=4c8437e195b6bcf6ab501ec187e23bd42d0469cd;hpb=25b75559e2d9bf84e2de35b851d93fefdae36e17;p=talweg.git diff --git a/pkg/R/Forecaster.R b/pkg/R/Forecaster.R deleted file mode 100644 index 4c8437e..0000000 --- a/pkg/R/Forecaster.R +++ /dev/null @@ -1,71 +0,0 @@ -#' Forecaster -#' -#' Forecaster (abstract class, implemented by all forecasters) -#' -#' @field params List of computed parameters, for post-run analysis (dev) -#' @field data Dataset, object of class Data -#' @field pjump Function: how to predict the jump at day interface ? -#' -#' @docType class -#' @importFrom R6 R6Class -Forecaster = R6::R6Class("Forecaster", - private = list( - .params = "list", - .data = "Data", - .pjump = "function" - ), - public = list( - initialize = function(data, pjump) - initialize(self, private, data, pjump) - , - predictSerie = function(today, memory, horizon, ...) - predictSerie(private, today, memory, horizon, ...) - , - predictShape = function(today, memory, horizon, ...) - predictShape(private, today, memory, horizon, ...) - , - getParameters = function() - getParameters(private) - ) -) - -#' Initialize (generic) Forecaster object -#' -#' @param o Object of class Forecaster -#' @param private List of private members in o -#' @param data Object of class Data -#' @param pjump Function to predict jump -initialize = function(o, private, data, pjump) -{ - .params <<- list() - .data <<- data - .pjump <<- pjump - invisible(o) -} - -#' Obtain a new forecasted time-serie -#' -#' @inheritParams initialize -#' @param today Index for current prediction -#' @param memory Depth in data (in days) -#' @param horizon Number of hours to forecast -predictSerie = function(private, today, memory, horizon, ...) -{ - # Parameters (potentially) computed during shape prediction stage - predicted_shape = predictShape(today, memory, horizon, ...) - predicted_delta = private$.pjump(private$.data, today, memory, horizon, params, ...) - # Predicted shape is aligned it on the end of current day + jump - predicted_shape + tail(private$.data$getSerie(today),1) - predicted_shape[1] + predicted_delta -} - -#' Shape prediction (centered curve) -#' -#' @inheritParams predictSerie -predictShape = function(private, today, memory, horizon, ...) - #empty default implementation: to implement in inherited classes - -#' Get parameters list -#' -#' @inheritParams initialize -getParameters = function(private) - private$.params