output_file arg

Author: wlandau

Diff for: DESCRIPTION

@@ -54,7 +54,7 @@ Imports:
 Suggests:
   curl (>= 4.3),
   knitr (>= 1.28),
-  quarto (>= 1.0),
+  quarto (>= 1.4),
   rmarkdown (>= 2.1),
   testthat (>= 3.0.0),
   xml2 (>= 1.3.2)

Diff for: NEWS.md

@@ -4,6 +4,7 @@
 * `tar_map()` and other static branching target factories now append values to the target descriptions. Use the `descriptions` argument of those functions to customize.
 * Ensure consistent `repository` settings in `tar_change()` and `tar_map_rep()`.
 * `tar_knit()`, `tar_render()`, `tar_quarto()`, and their "rep" and "raw" versions all gain a `working_directory` argument to change the working directory the report knits from. Users who set `working_directory` need to supply the `store` argument of `tar_load()` and `tar_read()` relative to the working directory so the report knows where to find the data.
+* `tar_knit()`, `tar_render()`, `tar_quarto()`, and their "raw" versions all gain an `output_file` argument to more conveniently set the file path to the rendered output file.
 
 # tarchetypes 0.7.12
 

Diff for: R/tar_knit.R

@@ -71,7 +71,7 @@
 tar_knit <- function(
   name,
   path,
-  output = NULL,
+  output_file = NULL,
   working_directory = NULL,
   tidy_eval = targets::tar_option_get("tidy_eval"),
   packages = targets::tar_option_get("packages"),
@@ -90,8 +90,8 @@ tar_knit <- function(
 ) {
   targets::tar_assert_package("knitr")
   targets::tar_assert_file(path)
-  targets::tar_assert_chr(output %|||% "x")
-  targets::tar_assert_scalar(output %|||% "x")
+  targets::tar_assert_chr(output_file %|||% "x")
+  targets::tar_assert_scalar(output_file %|||% "x")
   if (!is.null(working_directory)) {
     targets::tar_assert_file(working_directory)
   }
@@ -103,7 +103,13 @@ tar_knit <- function(
   )
   targets::tar_target_raw(
     name = targets::tar_deparse_language(substitute(name)),
-    command = tar_knit_command(path, output, working_directory, args, quiet),
+    command = tar_knit_command(
+      path,
+      output_file,
+      working_directory,
+      args,
+      quiet
+    ),
     packages = packages,
     library = library,
     format = "file",
@@ -120,9 +126,15 @@ tar_knit <- function(
   )
 }
 
-tar_knit_command <- function(path, output, working_directory, args, quiet) {
+tar_knit_command <- function(
+  path,
+  output_file,
+  working_directory,
+  args,
+  quiet
+) {
   args$input <- path
-  args$output <- output
+  args$output <- output_file
   args$quiet <- quiet
   deps <- call_list(as_symbols(knitr_deps(path)))
   fun <- call_ns("tarchetypes", "tar_knit_run")

Diff for: R/tar_knit_raw.R

@@ -57,7 +57,7 @@
 tar_knit_raw <- function(
   name,
   path,
-  output = NULL,
+  output_file = NULL,
   working_directory = NULL,
   packages = targets::tar_option_get("packages"),
   library = targets::tar_option_get("library"),
@@ -76,8 +76,8 @@ tar_knit_raw <- function(
   targets::tar_assert_package("knitr")
   targets::tar_assert_file(path)
   targets::tar_assert_not_dirs(path)
-  targets::tar_assert_chr(output %|||% "x")
-  targets::tar_assert_scalar(output %|||% "x")
+  targets::tar_assert_chr(output_file %|||% "x")
+  targets::tar_assert_scalar(output_file %|||% "x")
   if (!is.null(working_directory)) {
     targets::tar_assert_file(working_directory)
   }
@@ -87,7 +87,7 @@ tar_knit_raw <- function(
     name = name,
     command = tar_knit_command(
       path,
-      output,
+      output_file,
       working_directory,
       knit_arguments,
       quiet

Diff for: R/tar_quarto.R

@@ -117,6 +117,7 @@
 tar_quarto <- function(
   name,
   path = ".",
+  output_file = NULL,
   working_directory = NULL,
   extra_files = character(0),
   execute = TRUE,
@@ -149,6 +150,7 @@ tar_quarto <- function(
   tar_quarto_raw(
     name = name,
     path = path,
+    output_file = output_file,
     working_directory = working_directory,
     extra_files = extra_files,
     execute = execute,

Diff for: R/tar_quarto_raw.R

@@ -109,6 +109,7 @@
 tar_quarto_raw <- function(
   name,
   path = ".",
+  output_file = NULL,
   working_directory = NULL,
   extra_files = character(0),
   execute = TRUE,
@@ -138,6 +139,9 @@ tar_quarto_raw <- function(
   targets::tar_assert_chr(extra_files)
   targets::tar_assert_nzchar(extra_files)
   targets::tar_assert_file(path)
+  targets::tar_assert_chr(output_file %|||% "x")
+  targets::tar_assert_scalar(output_file %|||% "x")
+  targets::tar_assert_nzchar(output_file %|||% "x")
   if (!is.null(working_directory)) {
     targets::tar_assert_file(working_directory)
   }
@@ -170,6 +174,7 @@ tar_quarto_raw <- function(
   }
   command <- tar_quarto_command(
     path = path,
+    output_file = output_file,
     working_directory = working_directory,
     sources = sources,
     output = output,
@@ -202,6 +207,7 @@ tar_quarto_raw <- function(
 
 tar_quarto_command <- function(
   path,
+  output_file,
   working_directory,
   sources,
   output,
@@ -218,6 +224,7 @@ tar_quarto_command <- function(
   args <- substitute(
     list(
       input = path,
+      output_file = output_file,
       execute = execute,
       execute_params = execute_params,
       execute_dir = execute_dir,
@@ -233,6 +240,7 @@ tar_quarto_command <- function(
     ),
     env = list(
       path = path,
+      output_file = output_file,
       execute = execute,
       execute_dir = working_directory %|||% quote(getwd()),
       execute_params = execute_params,

Diff for: R/tar_render.R

@@ -50,7 +50,7 @@
 #' @inheritParams rmarkdown::render
 #' @param path Character string, file path to the R Markdown source file.
 #'   Must have length 1.
-#' @param output Character string, file path to the rendered output file.
+#' @param output_file Character string, file path to the rendered output file.
 #' @param working_directory Optional character string,
 #'   path to the working directory
 #'   to temporarily set when running the report.
@@ -123,7 +123,7 @@
 tar_render <- function(
   name,
   path,
-  output = NULL,
+  output_file = NULL,
   working_directory = NULL,
   tidy_eval = targets::tar_option_get("tidy_eval"),
   packages = targets::tar_option_get("packages"),
@@ -142,6 +142,9 @@ tar_render <- function(
 ) {
   targets::tar_assert_package("rmarkdown")
   targets::tar_assert_file(path)
+  targets::tar_assert_chr(output_file %|||% "x")
+  targets::tar_assert_scalar(output_file %|||% "x")
+  targets::tar_assert_nzchar(output_file %|||% "x")
   if (!is.null(working_directory)) {
     targets::tar_assert_file(working_directory)
   }
@@ -155,7 +158,7 @@ tar_render <- function(
     name = targets::tar_deparse_language(substitute(name)),
     command = tar_render_command(
       path,
-      output,
+      output_file,
       working_directory,
       args,
       quiet

Diff for: R/tar_render_raw.R

@@ -84,7 +84,7 @@
 tar_render_raw <- function(
   name,
   path,
-  output = NULL,
+  output_file = NULL,
   working_directory = NULL,
   packages = targets::tar_option_get("packages"),
   library = targets::tar_option_get("library"),
@@ -100,9 +100,9 @@ tar_render_raw <- function(
 ) {
   targets::tar_assert_package("rmarkdown")
   targets::tar_assert_file(path)
-  targets::tar_assert_chr(output %|||% "x")
-  targets::tar_assert_scalar(output %|||% "x")
-  targets::tar_assert_nzchar(output %|||% "x")
+  targets::tar_assert_chr(output_file %|||% "x")
+  targets::tar_assert_scalar(output_file %|||% "x")
+  targets::tar_assert_nzchar(output_file %|||% "x")
   if (!is.null(working_directory)) {
     targets::tar_assert_file(working_directory)
   }
@@ -112,7 +112,7 @@ tar_render_raw <- function(
     name = name,
     command = tar_render_command(
       path,
-      output,
+      output_file,
       working_directory,
       render_arguments,
       quiet

Diff for: inst/WORDLIST

@@ -23,6 +23,7 @@ Boneri
 Bostock
 brancher
 Broman
+CLI
 Broman's
 bugfix
 Bugfix