Try to fix Rd for CRAN

Author: wlandau-lilly

NEWS.md

@@ -1,3 +1,7 @@
+# targets 1.3.2
+
+* Try to fix function help files for CRAN.
+
 # targets 1.3.1
 
 * Add `tar_config_projects()` and `tar_config_yaml()` (#1153, @psychelzh).

R/class_database.R

@@ -44,7 +44,7 @@ database_init <- function(
     tar_throw_validate(
       "unsupported repository \"",
       repository,
-      "\" for {targets} database class."
+      "\" for `targets` database class."
     )
   )
 }

R/class_database_aws.R

@@ -35,7 +35,7 @@ database_aws_class <- R6::R6Class(
         self$resources$aws,
         "tar_resources_aws",
         msg = paste(
-          "Resources must be supplied to the {targets} AWS ",
+          "Resources must be supplied to the `targets` AWS ",
           "database class. Set resources with tar_option_set()"
         )
       )

R/class_database_gcp.R

@@ -35,7 +35,7 @@ database_gcp_class <- R6::R6Class(
         self$resources$gcp,
         "tar_resources_gcp",
         msg = paste(
-          "GCP resources must be supplied to the {targets} GCP ",
+          "GCP resources must be supplied to the `targets` GCP ",
           "database class. Set resources with tar_option_set()"
         )
       )

R/class_options.R

@@ -406,7 +406,7 @@ options_class <- R6::R6Class(
       if (is.numeric(backoff)) {
         tar_warn_deprecate(
           "The use of a numeric for the backoff argument of ",
-          "tar_option_set() is deprecated as of {targets} 1.1.0 ",
+          "tar_option_set() is deprecated as of `targets` 1.1.0 ",
           "(2023-05-09). Supply the output of tar_backoff() instead."
         )
         tar_assert_ge(backoff, 0.001)

R/tar_debug_instructions.R

@@ -59,6 +59,6 @@ tar_debug_instructions <- function() {
     )
   }
   cli_blank(
-    "Then debug the function as you would normally (without {targets})."
+    "Then debug the function as you would normally (without `targets`)."
   )
 }

R/tar_engine_knitr.R

@@ -2,15 +2,15 @@
 #' @export
 #' @family Target Markdown
 #' @seealso <https://books.ropensci.org/targets/literate-programming.html>
-#' @description `knitr` language engine that runs `{targets}`
+#' @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.
 #' @section Target Markdown interactive mode:
 #'   Target Markdown has two modes:
 #'   1. Non-interactive mode. This is the default when you
 #'     run `knitr::knit()` or `rmarkdown::render()`.
-#'     Here, the code in `{targets}` code chunks gets written
+#'     Here, the code in ``targets`` code chunks gets written
 #'     to special script files in order to set up a `targets`
 #'     pipeline to run later.
 #'   2. Interactive mode: here, no scripts are written to set up
@@ -80,7 +80,7 @@
 #' if (requireNamespace("knitr", quietly = TRUE)) {
 #'   knitr::knit_engines$set(targets = targets::tar_engine_knitr)
 #' }
-#' # Then, {targets} code chunks in a knitr report will run
+#' # Then, `targets` code chunks in a knitr report will run
 #' # as described at
 #' # <https://books.ropensci.org/targets/literate-programming.html>.
 #' }
@@ -376,7 +376,7 @@ warn_labels_unnamed <- function(options) {
   suppressed <- identical(Sys.getenv("TAR_WARN"), "false")
   if (!suppressed && any(grepl("unnamed-chunk-[0-9]*$", options$tar_name))) {
     tar_warn_validate(
-      "Please assign explicit labels to {targets} code chunks ",
+      "Please assign explicit labels to `targets` code chunks ",
       "in order to avoid accidental duplicated script files. ",
       "Warnings like this one are important, ",
       "but you can suppress them with Sys.setenv(TAR_WARN = \"false\")."

R/tar_resources_aws.R

@@ -17,10 +17,10 @@
 #' @param prefix Character of length 1, "directory path"
 #'   in the bucket where your target object and metadata will go.
 #'   Please supply an explicit prefix
-#'   unique to your {targets} project.
-#'   In the future, {targets} will begin requiring
+#'   unique to your `targets` project.
+#'   In the future, `targets` will begin requiring
 #'   explicitly user-supplied prefixes. (This last note
-#'   was added on 2023-08-24: {targets} version 1.2.2.9000.)
+#'   was added on 2023-08-24: `targets` version 1.2.2.9000.)
 #' @param region Character of length 1, AWS region containing the S3 bucket.
 #'   Set to `NULL` to use the default region.
 #' @param part_size Positive numeric of length 1, number of bytes

R/use_targets_rmd.R

@@ -2,7 +2,7 @@
 #' @export
 #' @family help
 #' @description Create an example Target Markdown report
-#'   to get started with {targets}.
+#'   to get started with `targets`.
 #' @return `NULL` (invisibly).
 #' @param path Character of length 1, output path of the
 #'   Target Markdown report relative to the current active

R/utils_assert.R

@@ -639,13 +639,13 @@ tar_assert_script <- function(script) {
   tar_assert_not_in(vars, choices, msg)
   msg <- paste(
     "Do not use %s() from {devtools} or {pkgload} to load",
-    "packages or custom functions/globals for {targets}. If you do,",
-    "custom functions will go to a package environment where {targets}",
+    "packages or custom functions/globals for `targets`. If you do,",
+    "custom functions will go to a package environment where `targets`",
     "may not track them, and the loaded data will not be available in",
     "parallel workers created by tar_make_clustermq() or tar_make_future().",
     "Read https://books.ropensci.org/targets/packages.html#loading-and-configuring-r-packages", # nolint
     "and https://books.ropensci.org/targets/packages.html#package-based-invalidation", # nolint
-    "for the correct way to load packages for {targets} pipelines.",
+    "for the correct way to load packages for `targets` pipelines.",
     "Warnings like this one are important, but if you must suppress them, ",
     "you can do so with Sys.setenv(TAR_WARN = \"false\")."
   )
@@ -779,10 +779,10 @@ tar_deprecate_seconds_interval <- function(seconds_interval) {
 tar_warn_prefix <- function() {
   tar_warn_deprecate(
     "Please supply an explicit prefix for you target object data ",
-    "and metadata. The prefix should be unique to your {targets} project. ",
-    "In the future, {targets} will begin requiring explicitly ",
+    "and metadata. The prefix should be unique to your `targets` project. ",
+    "In the future, `targets` will begin requiring explicitly ",
     "user-supplied prefixes. This warning was added on 2023-08-24 ",
-    "({targets} version 1.2.2.9000)."
+    "(`targets` version 1.2.2.9000)."
   )
 }