fix: resolve issue with detect_anomalies and minor changes to docs

Author: MMenchero

DESCRIPTION

@@ -14,7 +14,7 @@ Description: A Software Development Kit for working with 'Nixtla''s 'TimeGPT', a
 License: Apache License (>= 2.0)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.2
 Depends: 
     R (>= 2.10)
 LazyData: true

R/nixtla_client_cross_validation.R

@@ -1,5 +1,4 @@
-#' Sequential version of 'nixtla_client_cross_validation'
-#' This is a private function of 'nixtlar'
+#' `TimeGPT` cross-validation
 #'
 #' @param df A data frame with time series data.
 #' @param h Forecast horizon.

R/nixtla_client_detect_anomalies.R

@@ -1,5 +1,4 @@
-#' Sequential version of 'nixtla_client_detect_anomalies'
-#' This is a private function of 'nixtlar'
+#' `TimeGPT` detect anomalies
 #'
 #' @param df A data frame with time series data.
 #' @param freq Frequency of the data.
@@ -132,7 +131,7 @@ nixtla_client_detect_anomalies <- function(df, freq=NULL, id_col="unique_id", ti
     dplyr::group_by(.data$unique_id) |>
     dplyr::group_split()
 
-  df_tail <- purrr::map2_dfr(grouped_df_list, unique(df_info$fitted_sizes), ~slice_tail(.x, n = .y))
+  df_tail <- purrr::map2_dfr(grouped_df_list, df_info$fitted_sizes, ~slice_tail(.x, n = .y))
 
   nch <- nchar(df_tail$ds[1])
   if(nch <= 10){

R/nixtla_client_forecast.R

@@ -1,5 +1,4 @@
-#' Sequential version of 'nixtla_client_forecast'
-#' This is a private function of 'nixtlar'
+#' `TimeGPT` forecast
 #'
 #' @param df A data frame with time series data.
 #' @param h Forecast horizon.
@@ -293,7 +292,7 @@ nixtla_client_forecast <- function(df, h=8, freq=NULL, id_col="unique_id", time_
   }
 
   dates_long_df <- dates_long_df |>
-      dplyr::arrange(.data$unique_id)
+    dplyr::arrange(.data$unique_id)
 
   forecast <- cbind(dates_long_df, fc)
 
@@ -323,7 +322,7 @@ nixtla_client_forecast <- function(df, h=8, freq=NULL, id_col="unique_id", time_
       finetune_depth=finetune_depth,
       finetune_loss=finetune_loss,
       clean_ex_first=clean_ex_first
-      )
+    )
 
     forecast <- dplyr::bind_rows(fitted, forecast)
   }

R/nixtla_client_historic.R

@@ -1,5 +1,4 @@
-#' Sequential version of 'nixtla_client_historic'
-#' This is a private function of 'nixtlar'
+#' `TimeGPT` historic forecast
 #'
 #' @param df A tsibble or a data frame with time series data.
 #' @param freq Frequency of the data.

man/nixtla_client_cross_validation.Rd

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: ca86021f-c038-40e9-bfb8-ddf11abd4e3d
 
 RestoreWorkspace: No
 SaveWorkspace: No

man/nixtla_client_detect_anomalies.Rd

@@ -0,0 +1,141 @@
+{
+    "input_tokens": 85080,
+    "output_tokens": 120,
+    "finetune_tokens": 0,
+    "mean": [
+        47.05948,
+        49.2811,
+        50.786232,
+        50.800903,
+        49.80066,
+        51.497253,
+        52.020813,
+        53.910717,
+        54.81732,
+        56.888443,
+        54.694492,
+        54.15711,
+        53.05413,
+        53.414883,
+        54.19707,
+        54.60037,
+        59.234734,
+        60.023224,
+        55.22892,
+        48.512203,
+        51.469536,
+        53.43322,
+        53.537262,
+        51.826675,
+        -27.75719,
+        -27.913132,
+        -28.211796,
+        -28.810095,
+        -27.907024,
+        -27.640638,
+        -27.676228,
+        -26.66798,
+        -26.83917,
+        -25.48255,
+        -26.061874,
+        -26.585987,
+        -27.087431,
+        -27.66879,
+        -27.338823,
+        -26.570395,
+        -25.710356,
+        -25.111683,
+        -24.808588,
+        -24.686651,
+        -23.568918,
+        -25.699728,
+        -26.651564,
+        -27.942074,
+        64.57185,
+        65.58143,
+        65.14525,
+        64.89398,
+        62.981873,
+        65.36322,
+        66.913956,
+        69.469055,
+        68.640015,
+        70.03793,
+        67.664474,
+        66.10207,
+        65.07356,
+        62.830975,
+        62.535202,
+        61.945793,
+        66.3739,
+        68.38097,
+        65.30461,
+        59.633972,
+        64.35616,
+        67.64073,
+        67.20606,
+        63.724087,
+        51.859756,
+        51.88111,
+        51.894783,
+        51.821037,
+        51.807297,
+        51.853058,
+        51.942238,
+        51.96409,
+        51.856926,
+        51.708946,
+        51.73094,
+        51.60405,
+        51.599693,
+        51.468937,
+        51.384018,
+        51.224514,
+        51.020195,
+        51.214714,
+        51.432236,
+        51.42369,
+        51.60919,
+        51.60258,
+        51.60228,
+        51.521454,
+        24.89881,
+        25.9897,
+        26.135288,
+        27.016626,
+        28.175583,
+        26.539783,
+        25.56105,
+        25.664215,
+        27.217247,
+        27.094715,
+        25.673601,
+        24.59826,
+        24.126513,
+        24.002203,
+        23.67225,
+        23.219694,
+        23.433764,
+        29.063866,
+        28.252031,
+        28.035812,
+        27.629639,
+        25.34159,
+        23.499353,
+        24.88516
+    ],
+    "intervals": null,
+    "weights_x": [
+        80.0,
+        63.0,
+        53.0,
+        52.0,
+        44.0,
+        28.0,
+        26.0,
+        1332.0,
+        1322.0
+    ],
+    "feature_contributions": null,
+    "request_id": "RV74JU7M3Q"
+}