sa.decomposition -> sa_decomposition

sa.preprocessing -> sa_preprocessing

NAMESPACE

@@ -199,7 +199,8 @@ export(remove_outlier)
 export(remove_ramp)
 export(result)
 export(sa.decomposition)
-export(sa.preprocessing)
+export(sa_decomposition)
+export(sa_preprocessing)
 export(sadecomposition)
 export(sarima_decompose)
 export(sarima_estimate)

R/decomposition.R

@@ -4,7 +4,7 @@
 NULL
 
 
-#' @rdname sa.decomposition
+#' @rdname sa_decomposition
 #' @export
 sadecomposition<-function(y, sa, t, s, i, mul){
   if (! is.logical(mul))stop("Invalid SA decomposition")
@@ -33,7 +33,7 @@ sadecomposition<-function(y, sa, t, s, i, mul){
   return (structure(list(series=y, sa=sa, trend=t, seas=s, irr=i, multiplicative=mul), class=c("JD3_SADECOMPOSITION", "JD3")))
 }
 
-#' @rdname sa.decomposition
+#' @rdname sa_decomposition
 #' @export
 print.JD3_SADECOMPOSITION<-function(x, n_last_obs = frequency(x$series), ...){
   cat("Last values\n")
@@ -43,7 +43,7 @@ print.JD3_SADECOMPOSITION<-function(x, n_last_obs = frequency(x$series), ...){
     )
   )
 }
-#' @rdname sa.decomposition
+#' @rdname sa_decomposition
 #' @export
 plot.JD3_SADECOMPOSITION <- function(x, first_date = NULL, last_date = NULL,
                        type_chart = c("sa-trend", "seas-irr"),

R/generics.R

@@ -6,7 +6,7 @@
 #'
 #' @export
 diagnostics<-function(x, ...){
-  UseMethod("diagnostics")
+  UseMethod("diagnostics", x)
 }
 
 
@@ -24,15 +24,15 @@ diagnostics.JD3<-function(x, ...){
 #' @param x,... parameters.
 #'
 #' @export
-sa.preprocessing<-function(x, ...){
-  UseMethod("sa.preprocessing")
+sa_preprocessing<-function(x, ...){
+  UseMethod("sa_preprocessing", x)
 }
 
 
 #' Generic Function for Seasonal Adjustment Decomposition
 #'
 #' Generic function to format the seasonal adjustment decomposition components.
-#' \code{sa.decomposition()} is a generic function defined in other packages.
+#' \code{sa_decomposition()} is a generic function defined in other packages.
 #'
 #' @param y,sa,t,s,i,mul seasonal adjustment decomposition parameters.
 #' @param x the object to print.
@@ -45,11 +45,25 @@ sa.preprocessing<-function(x, ...){
 #' @param ... further arguments.
 #'
 #' @return \code{"JD3_SADECOMPOSITION"} object.
-#' @name sa.decomposition
+#' @name sa_decomposition
 NULL
 
 #' @export
-#' @rdname sa.decomposition
+#' @rdname sa_decomposition
+sa_decomposition<-function(x, ...){
+  UseMethod("sa_decomposition", x)
+}
+
+#' Deprecated functions
+#'
+#' @description
+#' Use [sa_decomposition()] instead of `sa.decomposition()`.
+#'
+#' @inheritParams sa_decomposition
+#' @name deprecated-rjd3toolkit
+#' @export
+#' @export
 sa.decomposition<-function(x, ...){
-  UseMethod("sa.decomposition")
+  .Deprecated("sa_decomposition")
+  UseMethod("sa_decomposition", x)
 }