Fix #503

NAMESPACE

@@ -278,6 +278,7 @@ export(tar_group)
 export(tar_helper)
 export(tar_helper_raw)
 export(tar_invalidate)
+export(tar_knitr_engine)
 export(tar_load)
 export(tar_load_globals)
 export(tar_load_raw)

R/utils_knitr.R → R/tar_knitr_engine.R

@@ -1,4 +1,19 @@
-knitr_engine <- function(options) {
+#' @title Target Markdown `knitr` engine
+#' @export
+#' @family targetopia
+#' @seealso <https://books.ropensci.org/targets/markdown.html>
+#' @description `knitr` language engine that runs `{targets}`
+#'   code chunks in Target Markdown.
+#' @return Character, output generated from `knitr::engine_output()`.
+#' @param options A named list of `knitr` chunk options.
+#' @examples
+#' # Register the engine.
+#' if (requireNamespace("knitr", quietly = TRUE)) {
+#'   knitr::knit_engines$set(targets = tar_knitr_engine)
+#' }
+#' # Then, {targets} code chunks in a knitr report will run
+#' # as described at https://books.ropensci.org/targets/markdown.html.
+tar_knitr_engine <- function(options) {
   assert_package("knitr")
   assert_list(options, "knitr chunk options must be a list.")
   assert_chr(options$label, "knitr chunk must have a label")
@@ -193,6 +208,6 @@ warn_labels_unnamed <- function(options) {
 
 knitr_engine_set <- function() {
   if (requireNamespace("knitr", quietly = TRUE)) {
-    knitr::knit_engines$set(targets = function(options) knitr_engine(options))
+    knitr::knit_engines$set(targets = function(options) tar_knitr_engine(options))
   }
 }

R/tar_test.R

@@ -1,6 +1,6 @@
 #' @title Test code in a temporary directory.
 #' @export
-#' @family tar_test
+#' @family targetopia
 #' @description Runs a `test_that()` unit test inside a temporary
 #'   directory to avoid writing to the user's file space.
 #'   This helps ensure compliance with CRAN policies.

_pkgdown.yml

@@ -116,4 +116,5 @@ reference:
 - title: Targetopia
   contents:
   - '`tar_dir`'
+  - '`tar_knitr_engine`'
   - '`tar_test`'