diff --git a/R/cancel.R b/R/cancel.R index 889a6e6..41c7202 100644 --- a/R/cancel.R +++ b/R/cancel.R @@ -2,7 +2,6 @@ #' #' @export #' @inheritParams proof_start -#' @references #' @inheritSection proof_status Timeout #' @return On success, a list with a single field: #' - `message` (character) diff --git a/R/info.R b/R/info.R index 0a1bcc7..6c8efc9 100644 --- a/R/info.R +++ b/R/info.R @@ -1,7 +1,6 @@ #' Get information about PROOF server #' #' @export -#' @references #' @return A list with fields: #' - `branch` (character): git branch of API #' - `commit_sha` (character): SHA of the git commit of the API diff --git a/R/start.R b/R/start.R index 67fd95c..27c6d0e 100644 --- a/R/start.R +++ b/R/start.R @@ -10,11 +10,9 @@ #' here as a string. Either pass it using [Sys.getenv()] or save your #' token as an env var and then passing nothing to this param and we'll find #' it -#' @references #' @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. See the link to proof-api for more details about the -#' slurm account. +#' PROOF API #' @inheritSection proof_status Timeout #' @section Cromwell Server uptime: #' The Cromwell server started by this function will run for 7 days diff --git a/R/status.R b/R/status.R index 1e9c60a..a484c17 100644 --- a/R/status.R +++ b/R/status.R @@ -6,7 +6,6 @@ #' @param wait (logical) if `TRUE` wait for the server to be ready to #' interact with. if `FALSE` return immediately, then you'll want to call #' this function again until you get the server URL -#' @references #' @section Timeout: #' If the PROOF API is unavailable, this function will timeout after #' 5 seconds. Contact the package maintainer if you get a timeout error. diff --git a/man/proof_cancel.Rd b/man/proof_cancel.Rd index ba4eec2..3b53b81 100644 --- a/man/proof_cancel.Rd +++ b/man/proof_cancel.Rd @@ -31,6 +31,3 @@ If the PROOF API is unavailable, this function will timeout after See \code{\link[=proof_timeout]{proof_timeout()}}. } -\references{ -\url{https://github.com/FredHutch/proof-api#delete-cromwell-server} -} diff --git a/man/proof_info.Rd b/man/proof_info.Rd index d54726f..26a4fa0 100644 --- a/man/proof_info.Rd +++ b/man/proof_info.Rd @@ -19,6 +19,3 @@ A list with fields: \description{ Get information about PROOF server } -\references{ -\url{https://github.com/FredHutch/proof-api?tab=readme-ov-file#get-info} -} diff --git a/man/proof_start.Rd b/man/proof_start.Rd index d531a2d..e6c77f8 100644 --- a/man/proof_start.Rd +++ b/man/proof_start.Rd @@ -31,8 +31,7 @@ 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. See the link to proof-api for more details about the -slurm account. +PROOF API } \section{Cromwell Server uptime}{ @@ -50,6 +49,3 @@ If the PROOF API is unavailable, this function will timeout after See \code{\link[=proof_timeout]{proof_timeout()}}. } -\references{ -\url{https://github.com/FredHutch/proof-api/#post-cromwell-server} -} diff --git a/man/proof_status.Rd b/man/proof_status.Rd index 6c08371..283455d 100644 --- a/man/proof_status.Rd +++ b/man/proof_status.Rd @@ -40,6 +40,3 @@ If the PROOF API is unavailable, this function will timeout after See \code{\link[=proof_timeout]{proof_timeout()}}. } -\references{ -\url{https://github.com/FredHutch/proof-api#get-cromwell-server} -}