Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trivial: Fix enumeration formatting #1160

Merged
merged 1 commit into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions R/tar_script.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,26 @@
#' and run it to set up the pipeline just prior to the main task.
#' Every target script file should run the following
#' steps in the order below:
#' 1. Package: load the `targets` package. This step is automatically
#'
#' 1. Package: load the `targets` package. This step is automatically
#' inserted at the top of the target script file produced by
#' `tar_script()` if `library_targets` is `TRUE`,
#' so you do not need to explicitly include it in `code`.
#' 1. Globals: load custom functions and global objects into memory.
#' 2. Globals: load custom functions and global objects into memory.
#' Usually, this section is a bunch of calls to `source()` that run
#' scripts defining user-defined functions. These functions support
#' the R commands of the targets.
#' 2. Options: call [tar_option_set()] to set defaults for targets-specific
#' 3. Options: call [tar_option_set()] to set defaults for targets-specific
#' settings such as the names of required packages. Even if you have no
#' specific options to set, it is still recommended to call
#' [tar_option_set()] in order to register the proper environment.
#' 3. Targets: define one or more target objects using [tar_target()].
#' 4. Pipeline: call [list()] to bring the targets from (3)
#' 4. Targets: define one or more target objects using [tar_target()].
#' 5. Pipeline: call [list()] to bring the targets from (3)
#' together in a pipeline object. Every target script file must return
#' a pipeline object, which usually means ending with a call to
#' [list()]. In practice, (3) and (4) can be combined together
#' in the same function call.
#'
#' @return `NULL` (invisibly).
#' @param code R code to write to the target script file.
#' If `NULL`, an example target script file is written instead.
Expand Down
12 changes: 7 additions & 5 deletions man/tar_script.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading