fix: rename outlier_tukey() and allow for turkey too #58 + cache new overwrite parameter

Author: laresbernardo

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: lares
 Type: Package
 Title: Analytics & Machine Learning Sidekick
-Version: 5.2.11.9003
+Version: 5.2.11.9004
 Authors@R: c(
     person("Bernardo", "Lares", , "laresbernardo@gmail.com", c("aut", "cre")))
 Maintainer: Bernardo Lares <laresbernardo@gmail.com>
@@ -39,7 +39,7 @@ Suggests:
     rmarkdown
 URL: https://github.com/laresbernardo/lares, https://laresbernardo.github.io/lares/
 BugReports: https://github.com/laresbernardo/lares/issues
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 License: AGPL-3
 Encoding: UTF-8
 LazyData: true

NAMESPACE

@@ -175,6 +175,7 @@ export(num_abbr)
 export(numericalonly)
 export(ohe_commas)
 export(ohse)
+export(outlier_tukey)
 export(outlier_turkey)
 export(outlier_zscore)
 export(outlier_zscore_plot)

R/cache.R

@@ -18,6 +18,8 @@
 #' if the cache should be used to proceed or ignored; when writing, (interactive)
 #' ask the user if the cache should be overwritten. Note that you can only ask for
 #' one cache file at a time because vectors are concatenated.
+#' @param overwrite Boolean. Set to overwrite existing cache file. When reading,
+#' this parameter answers to ask prompt instead.
 #' @param ... Additional parameters.
 #' @return \code{cache_write}. No return value, called for side effects.
 #' @examples
@@ -32,6 +34,7 @@ cache_write <- function(data,
                         base = "temp",
                         cache_dir = getOption("LARES_CACHE_DIR"),
                         ask = FALSE,
+                        overwrite = NULL,
                         quiet = FALSE,
                         ...) {
   if (is.null(cache_dir)) {
@@ -51,11 +54,11 @@ cache_write <- function(data,
     } else {
       answer <- "use"
     }
-    if (answer != "i") {
+    if (answer != "i" && isTRUE(overwrite)) {
       saveRDS(data, file = file)
       if (!quiet) message("> Cache saved succesfully: ", base)
     } else {
-      if (!quiet) message("> Skipped cache for: ", base)
+      if (!quiet) message("> Skipped writing cache for: ", base)
       return(invisible(NULL))
     }
   } else {
@@ -69,6 +72,7 @@ cache_write <- function(data,
 cache_read <- function(base,
                        cache_dir = getOption("LARES_CACHE_DIR"),
                        ask = FALSE,
+                       overwrite = TRUE,
                        quiet = FALSE,
                        ...) {
   base <- paste(base, collapse = ".")
@@ -78,13 +82,13 @@ cache_read <- function(base,
   if (exists) {
     file <- attr(exists, "filename")
     base <- attr(exists, "base")
-    if (ask == TRUE) {
+    if (ask) {
       message("> Cache found: ", base)
       answer <- readline("Press ENTER to use cache or type [i] to ignore: ")
     } else {
       answer <- "use"
     }
-    if (answer != "i") {
+    if (answer != "i" && isTRUE(overwrite)) {
       data <- readRDS(file)
       if (!quiet) message("> Cache loaded succesfully: ", base)
       return(data)

R/outliers.R

@@ -172,8 +172,11 @@ outlier_zscore_plot <- function(df, var, group = NULL,
 #' @param k Positive Numeric. K-multiplier.
 #' @return Boolean vector detecting outliers.
 #' @export
-outlier_turkey <- function(x, k = 1.5) {
+outlier_tukey <- function(x, k = 1.5) {
   quar <- quantile(x, probs = c(0.25, 0.75), na.rm = TRUE)
   iqr <- diff(quar)
   !((quar[1] - k * iqr <= x) & (x <= quar[2] + k * iqr))
 }
+#' @rdname outlier_tukey
+#' @export
+outlier_turkey <- outlier_tukey

R/stocks.R

@@ -6,6 +6,7 @@
 #'
 #' @family Investment
 #' @family Credentials
+#' @inheritParams cache_write
 #' @param file Character. Import an Excel file, local or from URL.
 #' @param creds Character. Dropbox's credentials (see \code{get_creds()})
 #' @param auto Boolean. Automatically use my local personal file? You might want
@@ -35,7 +36,8 @@ stocks_file <- function(file = NA,
                         sheets = c("Portafolio", "Fondos", "Transacciones"),
                         keep_old = TRUE,
                         cache = TRUE,
-                        quiet = FALSE) {
+                        quiet = FALSE,
+                        ...) {
   cache_file <- c(as.character(Sys.Date()), "stocks_file")
   if (cache_exists(cache_file) && cache) {
     results <- cache_read(cache_file, quiet = quiet)
@@ -46,12 +48,15 @@ stocks_file <- function(file = NA,
       as_tibble(read.xlsx(
         file,
         sheet = x,
-        skipEmptyRows = TRUE, detectDates = TRUE
+        skipEmptyRows = TRUE,
+        detectDates = TRUE
       ))
     })
     if (length(mylist) == 3) {
       names(mylist) <- c("port", "cash", "trans")
-      mylist$trans$Date <- try(as.Date(mylist$trans$Date, origin = "1970-01-01"))
+      mylist$port$StartDate <- try(as.Date(mylist$port$StartDate, origin = "1889-12-31", ...))
+      mylist$trans$Date <- try(as.Date(mylist$trans$Date, origin = "1889-12-31", ...))
+      mylist$cash$Date <- try(as.Date(mylist$cash$Date, origin = "1889-12-31", ...))
       if ("Value" %in% colnames(mylist$trans)) {
         mylist$trans <- rename(mylist$trans, Each = .data$Value, Invested = .data$Amount)
       }
@@ -96,7 +101,7 @@ stocks_file <- function(file = NA,
     attr(results$cash, "type") <- "stocks_file_cash"
   }
   attr(results, "type") <- "stocks_file"
-  cache_write(results, cache_file, quiet = TRUE)
+  cache_write(results, cache_file, quiet = TRUE, ...)
   return(results)
 }