From f56e176d26e5c1df2f21d063545464158dedc4bd Mon Sep 17 00:00:00 2001
From: Zachary Susswein <utb2@cdc.gov>
Date: Fri, 22 Nov 2024 19:49:09 +0000
Subject: [PATCH] Clarify config reqs in roxygen comment

---
 R/pipeline.R    | 6 +++---
 man/pipeline.Rd | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/R/pipeline.R b/R/pipeline.R
index 870551a..18c551c 100644
--- a/R/pipeline.R
+++ b/R/pipeline.R
@@ -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)
@@ -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/`
diff --git a/man/pipeline.Rd b/man/pipeline.Rd
index 1848d34..75643ed 100644
--- a/man/pipeline.Rd
+++ b/man/pipeline.Rd
@@ -15,8 +15,7 @@ execute_model_logic(config, output_dir)
 }
 \arguments{
 \item{config_path}{A string specifying the file path to the JSON
-configuration file. The configuration file should include at least \code{job_id}
-and \code{task_id} to manage the logging and task metadata.}
+configuration file.}
 
 \item{blob_storage_container}{Optional. The name of the blob storage
 container to which logs and outputs will be uploaded. If NULL, no upload
@@ -30,7 +29,8 @@ including paths to data, exclusions, disease parameters, model settings,
 and other necessary inputs.}
 }
 \value{
-The function does not return a value directly. However, the output
+The function returns a boolean, TRUE For pipeline success and FALSE
+otherwise. It writes the files:
 directory will contain the following files:
 \itemize{
 \item Model RDS file (\code{model.rds})