From 11914b3d44d98d0283e23f8671b107d064bb8d9e Mon Sep 17 00:00:00 2001
From: Scott Chamberlain <sachamber@fredhutch.org>
Date: Thu, 25 Jan 2024 11:38:22 -0800
Subject: [PATCH] fix #6 change pi_name param to slurm_account in proof_start

---
 R/start.R          | 19 +++++++++++--------
 man/proof_start.Rd | 17 ++++++++++-------
 2 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/R/start.R b/R/start.R
index ebe5d60..5dd3826 100644
--- a/R/start.R
+++ b/R/start.R
@@ -1,21 +1,24 @@
 #' Start PROOF Cromwell server
 #'
 #' @export
-#' @param pi_name (character) PI name in the form last_f; only needed if user
-#' is in more than one SLURM account
-#' @references <https://github.com/FredHutch/proof-api#post-cromwell-server>
+#' @param slurm_account (character) PI name in the form `last_f`, where last
+#' is the last name of the PI and f is the first name, e.g., "Jane Doe"
+#' would be `doe_j`; only needed if user is in more than one SLURM account.
+#' optional
+#' @references <https://github.com/FredHutch/proof-api/#post-cromwell-server>
 #' @details Does not return PROOF/Cromwell server URL, for that you have to
 #' periodically call [proof_status()], or wait for the email from the
-#' PROOF API
+#' PROOF API. See the link to proof-api for more details about the
+#' slurm account.
 #' @inheritSection proof_status Timeout
 #' @return A list with fields:
-#' - `job_id` (character)
-#' - `info` (character)
-proof_start <- function(pi_name = NULL) {
+#' - `job_id` (character) - the job ID
+#' - `info` (character) - message
+proof_start <- function(slurm_account = NULL) {
   response <- POST(
     make_url("cromwell-server"),
     proof_header(),
-    body = list(pi_name = pi_name),
+    body = list(slurm_account = slurm_account),
     encode = "json",
     timeout(proofr_env$timeout_sec)
   )
diff --git a/man/proof_start.Rd b/man/proof_start.Rd
index db18133..0f66639 100644
--- a/man/proof_start.Rd
+++ b/man/proof_start.Rd
@@ -4,17 +4,19 @@
 \alias{proof_start}
 \title{Start PROOF Cromwell server}
 \usage{
-proof_start(pi_name = NULL)
+proof_start(slurm_account = NULL)
 }
 \arguments{
-\item{pi_name}{(character) PI name in the form last_f; only needed if user
-is in more than one SLURM account}
+\item{slurm_account}{(character) PI name in the form \code{last_f}, where last
+is the last name of the PI and f is the first name, e.g., "Jane Doe"
+would be \code{doe_j}; only needed if user is in more than one SLURM account.
+optional}
 }
 \value{
 A list with fields:
 \itemize{
-\item \code{job_id} (character)
-\item \code{info} (character)
+\item \code{job_id} (character) - the job ID
+\item \code{info} (character) - message
 }
 }
 \description{
@@ -23,7 +25,8 @@ Start PROOF Cromwell server
 \details{
 Does not return PROOF/Cromwell server URL, for that you have to
 periodically call \code{\link[=proof_status]{proof_status()}}, or wait for the email from the
-PROOF API
+PROOF API. See the link to proof-api for more details about the
+slurm account.
 }
 \section{Timeout}{
 
@@ -33,5 +36,5 @@ See \code{\link[=proof_timeout]{proof_timeout()}}.
 }
 
 \references{
-\url{https://github.com/FredHutch/proof-api#post-cromwell-server}
+\url{https://github.com/FredHutch/proof-api/#post-cromwell-server}
 }