Skip to content

Commit

Permalink
Clarify config reqs in roxygen comment
Browse files Browse the repository at this point in the history
  • Loading branch information
zsusswein committed Nov 22, 2024
1 parent cfda935 commit f56e176
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions R/pipeline.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
#' outputs to a blob storage container is planned.
#'
#' @param config_path A string specifying the file path to the JSON
#' configuration file. The configuration file should include at least `job_id`
#' and `task_id` to manage the logging and task metadata.
#' configuration file.
#' @param blob_storage_container Optional. The name of the blob storage
#' container to which logs and outputs will be uploaded. If NULL, no upload
#' will occur. (Planned feature, not currently implemented)
Expand Down Expand Up @@ -57,7 +56,8 @@
#' └── logs.txt
#' ```
#'
#' @return The function does not return a value directly. However, the output
#' @return The function returns a boolean, TRUE For pipeline success and FALSE
#' otherwise. It writes the files:
#' directory will contain the following files:
#' - Model RDS file (`model.rds`)
#' - Sample output in Parquet format (`<task_id>.parquet` in the `samples/`
Expand Down
6 changes: 3 additions & 3 deletions man/pipeline.Rd

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

0 comments on commit f56e176

Please sign in to comment.