Skip to contents

Start PROOF Cromwell server

Usage

proof_start(slurm_account = NULL, token = NULL)

Arguments

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

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 using Sys.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:

  • job_id (character) - the job ID

  • info (character) - message

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

Cromwell Server uptime

The Cromwell server started by this function will run for 7 days and then shut down. However, your data persists across different instances of Cromwell servers created by running this function. You do however need to have a Cromwell server up and running to retrieve data.

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().