Get PROOF API job status - is job running, what's its URL...
Arguments
- wait
(logical) if
TRUE
wait for the server to be ready to interact with. ifFALSE
return immediately, then you'll want to call this function again until you get the server URL- token
(character) token for bearer authentication with the PROOF API. default is
NULL
. we do not recommend passing your token here as a string. Either pass it usingSys.getenv()
or save your token as an env var and then passing nothing to this param and we'll find it
Value
A list with fields:
canJobStart
(logical): can a job to make a Cromwell server be started?FALSE
if server already running;TRUE
if server not runningjobStatus
(character): status of the job that controls the Cromwell server. e.g., "RUNNING".NULL
if server not runningcromwellUrl
(character): the URL for the Cromwell server.NULL
if server not runningjobInfo
(list): metadata on the Cromwell server. All slotsNULL
if server not running
Timeout
If the PROOF API is unavailable, this function will timeout after
5 seconds. Contact the package maintainer if you get a timeout error.
See proof_timeout()
.