R/getSupportedMethods.R

Defines functions getSupportedPostProcessors getSupportedModels getSupportedPreparations

Documented in getSupportedModels getSupportedPostProcessors getSupportedPreparations

#' getSupportedPreparations
#'
#' Get a list of all data preparation methods that are currently supported in package 'eventDetectR'.
#'
#' @return allSupportedPreparations a list of strings with each supported method name.
#' The strings can be copied and used in calls to 'eventDetect' or 'buildEDModel'
#' @export
#'
#' @examples
#' preps <- getSupportedPreparations()
getSupportedPreparations <- function() {
    allSupportedPreparations <- list(
        supportedImputeTS = c("ImputeTSInterpolation",
                              "ImputeTSKalman",
                              "ImputeTSLOCF",
                              "ImputeTSMA",
                              "ImputeTSMean",
                              "ImputeTSRandom",
                              #"ImputeTSRemove",
                              "ImputeTSReplace"
                              #"ImputeTSSeadec",
                              #"ImputeTSSeasplit"
                              ),
        other = c()
    )
    return(allSupportedPreparations)
}

#' getSupportedModels
#'
#' Get a list of all data modelling methods that are currently supported in package 'eventDetectR'.
#'
#' @return allSupportedModels a list of strings with each supported method name. The strings can be copied and used in calls to 'eventDetect' or 'buildEDModel'
#' @export
#'
#' @examples
#' models <- getSupportedModels()
getSupportedModels <- function() {
    allSupportedModels <- list(
        supportedUnivariateForeCastModels = c("ForecastETS", "ForecastArima",
                                              "ForecastBats",
                                              "ForecastHolt",
                                              "ForecastMeanf",
                                              "ForecastRWF",
                                              "ForecastSplineF",
                                              "ForecastThetaf",
                                              "ForecastSES"
                                              ),
        supportedMultivariateModels=c("NeuralNetwork"),
        other = c()
    )
    return(allSupportedModels)
}

#' getSupportedPostProcessors
#'
#' Get a list of all data postprocessing methods that are currently supported in package 'eventDetectR'.
#'
#' @return allSupportedPostProcessors a list of strings with each supported method name. The strings can be copied and used in calls to 'eventDetect' or 'buildEDModel'
#' @export
#'
#' @examples
#' preps <- getSupportedPostProcessors()
getSupportedPostProcessors <- function() {
    allSupportedPostProcessors <- list(
        other = c("bedAlgo")
    )
    return(allSupportedPostProcessors)
}

Try the EventDetectR package in your browser

Any scripts or data that you put into this service are public.

EventDetectR documentation built on Jan. 13, 2021, 9:02 a.m.