export readRDS_or_return_alt_data() (#39)

NAMESPACE

@@ -12,6 +12,7 @@ export(empty_portfolio_results)
 export(get_build_version_msg)
 export(log_user_errors)
 export(quit_if_no_pacta_relevant_data)
+export(readRDS_or_return_alt_data)
 export(remove_if_exists)
 export(save_if_exists)
 export(set_analysis_inputs_path)

R/readRDS_or_return_alt_data.R

@@ -1,3 +1,15 @@
+#' Return the object stored in a RDS at a specified file path, or an alternate
+#' value/object if the file doesn't exist.
+#'
+#' @param filepath a single string containing a file path to a RDS file
+#' @param alt_return an R object/value to be returned if the file at `filepath`
+#'   does not exist
+#'
+#' @return an object, either the object stored in the RDS at the `filepath` or
+#'   the value of `alt_return`
+#'
+#' @export
+
 readRDS_or_return_alt_data <- function(filepath, alt_return = NULL) {
   if (file.exists(filepath)) {
     return(readRDS(filepath))