Merge pull request #16 from A2-ai/config

Config logic for 0.3.1

Author: mduncans

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: reportifyr
 Title: Reproducible Reporting Made Simple with R
-Version: 0.3.0
+Version: 0.3.1
 Authors@R: c(
     person("Jacob", "Dumbleton", , "[email protected]", role = c("aut", "cre")),
     person("Matthew", "Smith", , "[email protected]", role = "aut"),

NEWS.md

@@ -1,3 +1,18 @@
+# reportifyr 0.3.1
+## Minor Improvements
+
+* If `config_yaml` is left `NULL` for the following functions, a default `config.yaml` file bundled with `reportifyr` is used instead:
+  * `add_footnotes()`
+  * `add_plots()`
+  * `add_tables()`
+  * `build_report()`
+  * `finalize_document()`
+  * `remove_tables_figures_footnotes()`
+
+* `validate_input_args()` and `validate_alt_text_magic_strings()` no longer take a `config_yaml` argument.
+
+* Function and argument descriptions introduced or expanded on in 0.3.0 have been updated for clarity and understanding.
+  
 # reportifyr 0.3.0
 ## New Features
 

R/add_footnotes.R

@@ -78,7 +78,7 @@ add_footnotes <- function(
     browser()
   }
 
-  validate_input_args(docx_in, docx_out, config_yaml)
+  validate_input_args(docx_in, docx_out)
   validate_docx(docx_in, config_yaml)
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 
@@ -142,7 +142,7 @@ add_footnotes <- function(
 
   if (!is.null(config_yaml)) {
     if (!validate_config(config_yaml)) {
-      stop("Invalid confi yaml. Please fix")
+      stop("Invalid config yaml. Please fix")
     }
     log4r::info(
       .le$logger,
@@ -158,11 +158,10 @@ add_footnotes <- function(
       paste0("Using default config file: ", config_yaml)
     )
   }
-  if (!is.null(config_yaml)) {
-    log4r::info(.le$logger, "Adding config.yaml to args")
-    fig_args <- c(fig_args, "-c", config_yaml)
-    tab_args <- c(tab_args, "-c", config_yaml)
-  }
+  log4r::info(.le$logger, "Adding config.yaml to args")
+  fig_args <- c(fig_args, "-c", config_yaml)
+  tab_args <- c(tab_args, "-c", config_yaml)
+
   paths <- get_venv_uv_paths()
   log4r::debug(.le$logger, "Running figure footnotes script")
   tryCatch(

R/add_plots.R

@@ -4,7 +4,7 @@
 #' @param docx_in The file path to the input `.docx` file.
 #' @param docx_out The file path to the output `.docx` file to save to.
 #' @param figures_path The file path to the figures directory.
-#' @param config_yaml The path to config.yaml file that controls figure dimensions
+#' @param config_yaml The file path to the `config.yaml`. Default is `NULL`, a default `config.yaml` bundled with the `reportifyr` package is used.
 #' @param fig_width A global controller. The figure width in inches. Default is `NULL`. If `NULL`, the width is determined by the figure's pixel dimensions.
 #' @param fig_height A global controller. The figure height in inches. Default is `NULL`. If `NULL`, the height is determined by the figure's pixel dimensions.
 #' @param debug Debug.
@@ -59,7 +59,7 @@ add_plots <- function(
     browser()
   }
 
-  validate_input_args(docx_in, docx_out, config_yaml)
+  validate_input_args(docx_in, docx_out)
   validate_docx(docx_in, config_yaml)
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 
@@ -85,11 +85,14 @@ add_plots <- function(
     figures_path
   )
 
-  if (!is.null(config_yaml)) {
-    args <- c(args, "-c", config_yaml)
-    log4r::info(.le$logger, paste0("config yaml set: ", config_yaml))
+  if (is.null(config_yaml)) {
+    config_yaml <- system.file("extdata", "config.yaml", package = "reportifyr")
+    log4r::info(.le$logger, paste0("using built-in config.yaml: ", config_yaml))
   }
 
+  args <- c(args, "-c", config_yaml)
+  log4r::info(.le$logger, paste0("config yaml set: ", config_yaml))
+
   if (!is.null(fig_width)) {
     args <- c(args, "-w", fig_width)
     log4r::info(.le$logger, paste0("Figure width set: ", fig_width))

R/add_plots_alt_text.R

@@ -1,8 +1,8 @@
-#' add_plots_alt_text()
+#' Inserts alt text for figures within a Microsoft Word file.
 #'
-#' @param docx_in path to document
-#' @param docx_out path to output document with figures alt text
-#' @param debug boolean turns on browser
+#' @param docx_in The file path to the input `.docx` file.
+#' @param docx_out The file path to the output `.docx` file to save to.
+#' @param debug Debug.
 #'
 #' @export
 #'
@@ -22,7 +22,7 @@ add_plots_alt_text <- function(
     browser()
   }
 
-  validate_input_args(docx_in, docx_out, NULL)
+  validate_input_args(docx_in, docx_out)
 
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 

R/add_tables.R

@@ -4,7 +4,7 @@
 #' @param docx_in The file path to the input `.docx` file.
 #' @param docx_out The file path to the output `.docx` file to save to.
 #' @param tables_path The file path to the tables and associated metadata directory.
-#' @param config_yaml The path to config.yaml file that controls figure dimensions
+#' @param config_yaml The file path to the `config.yaml`. Default is `NULL`, a default `config.yaml` bundled with the `reportifyr` package is used.
 #' @param debug Debug.
 #'
 #' @export
@@ -45,7 +45,12 @@ add_tables <- function(
     browser()
   }
 
-  validate_input_args(docx_in, docx_out, config_yaml)
+  if (is.null(config_yaml)) {
+    config_yaml <- system.file("extdata", "config.yaml", package = "reportifyr")
+    log4r::info(.le$logger, paste0("using built-in config.yaml: ", config_yaml))
+  }
+
+  validate_input_args(docx_in, docx_out)
   validate_docx(docx_in, config_yaml)
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 

R/add_tables_alt_text.R

@@ -1,8 +1,8 @@
-#' add_tables_alt_text
+#' Inserts alt text for tables within a Microsoft Word file.
 #'
-#' @param docx_in path to input document
-#' @param docx_out path to output document
-#' @param debug boolean for turning on debugging
+#' @param docx_in The file path to the input `.docx` file.
+#' @param docx_out The file path to the output `.docx` file to save to.
+#' @param debug Debug.
 #'
 #' @export
 #'
@@ -22,7 +22,7 @@ add_tables_alt_text <- function(
     browser()
   }
 
-  validate_input_args(docx_in, docx_out, NULL)
+  validate_input_args(docx_in, docx_out)
 
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 

R/build_report.R

@@ -50,7 +50,12 @@ build_report <- function(
 ) {
   log4r::debug(.le$logger, "Starting build_report function")
 
-  validate_input_args(docx_in, docx_out, config_yaml)
+  if (is.null(config_yaml)) {
+    config_yaml <- system.file("extdata", "config.yaml", package = "reportifyr")
+    log4r::info(.le$logger, paste0("using built-in config.yaml: ", config_yaml))
+  }
+
+  validate_input_args(docx_in, docx_out)
   validate_docx(docx_in, config_yaml)
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 

R/finalize_document.R

@@ -3,7 +3,7 @@
 #' @description Reads in a `.docx` file and returns a finalized version with magic strings and bookmarks removed.
 #' @param docx_in The file path to the input `.docx` file.
 #' @param docx_out The file path to the output `.docx` file to save to. Default is `NULL`. If `NULL`, `docx_out` is assigned `doc_dirs$doc_final` using `make_doc_dirs(docx_in = docx_in)`.
-#' @param config_yaml The file path to the `config.yaml`.
+#' @param config_yaml The file path to the `config.yaml`. Default is `NULL`, a default `config.yaml` bundled with the `reportifyr` package is used.
 #'
 #' @export
 #'
@@ -45,7 +45,7 @@
 finalize_document <- function(
   docx_in,
   docx_out = NULL,
-  config_yaml
+  config_yaml = NULL
 ) {
   tictoc::tic()
   log4r::debug(.le$logger, "Starting finalize_document function")
@@ -59,7 +59,11 @@ finalize_document <- function(
     )
   }
 
-  validate_input_args(docx_in, docx_out, config_yaml)
+  if (is.null(config_yaml)) {
+    config_yaml <- system.file("extdata", "config.yaml", package = "reportifyr")
+  }
+
+  validate_input_args(docx_in, docx_out)
   validate_docx(docx_in, config_yaml)
   log4r::info(.le$logger, paste0("Output document path set: ", docx_out))
 

R/initialize_report_project.R

@@ -3,10 +3,10 @@
 #' @param project_dir The file path to the main project directory
 #' where the directory structure will be created.
 #' The directory must already exist; otherwise, an error will be thrown.
-#' @param report_dir_name The directory name for where reports will be saved,
-#' default NULL will use "report"
-#' @param outputs_dir_name The directory name for where artifacts will be saved,
-#' default NULL will use "OUTPUTS"
+#' @param report_dir_name The directory name for where reports will be saved.
+#' Default is `NULL`. If `NULL`, `report` will be used.
+#' @param outputs_dir_name The directory name for where artifacts will be saved.
+#' Default is `NULL`. If `NULL`, `OUTPUTS` will be used.
 #'
 #' @export
 #'