CRON Job (#22)

* CRON Job

* Fix example error, exclude folder

.Rbuildignore

@@ -8,6 +8,7 @@
 ^lfs_variables_report\.csv$
 ^aps_variables_report\.csv$
 ^data-raw$
+^lfs_documentation$
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$

.github/workflows/R-CMD-check.yaml

@@ -5,6 +5,8 @@ on:
     branches: [main, master]
   pull_request:
     branches: [main, master]
+  schedule:
+    - cron: "0 0 * * 1" # Once a week on monday
 
 name: R-CMD-check
 

DESCRIPTION

@@ -45,4 +45,4 @@ VignetteBuilder:
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

R/api.R

@@ -4,20 +4,20 @@
 #'
 #' @param dataset_id Name of ONS dataset
 #' @param timeseries_id Name of ONS time series
-#' @return A Jsonlite(?) object from the ONS API
+#' @return A list converted from json from the ONS API
 #' @keywords internal
-#' @examples
 #'
+#' @export
+#' @examplesIf interactive()
 #' # CPIH Inflation
-#' ons_time_series("MM23", "L55O") %>%
-#'   purrr::pluck("years") %>%
+#' ons_time_series("MM23", "L55O") |>
+#'   purrr::pluck("years") |>
 #'   dplyr::select(date, value)
 #'
 #' # Unemployment Rate
-#' ons_time_series("LMS", "MGSX") %>%
-#'   purrr::pluck("months") %>%
+#' ons_time_series("LMS", "MGSX") |>
+#'   purrr::pluck("months") |>
 #'   dplyr::select(date, value)
-#' @export
 ons_time_series <- function(dataset_id, timeseries_id) {
   api_endpoint <- "https://api.ons.gov.uk/"