Render a job in the background, detached from the session

Starts render_job on the job in a separate process that outlives the R session, the way nohup from a terminal does, and returns at once. Use it for a job whose fit runs for hours: a Workbench session that times out takes a console run with it.

Usage

submit_job(path, final = FALSE)

Arguments

path

Character(1). The job's .qmd file.

final

Logical(1). Passed to render_job.

Value

Invisibly, the job's status, as job_status returns it.

Details

The process runs the Rscript of the R that called submit_job(), from the study root, so the study's renv and .Renviron apply. It writes <job>.run.log (everything the render prints) and <job>.run.yml (its state) beside the job; read the state with job_status. A job already running is not started twice: a <job>.run.lock directory is taken while a submit is in progress, and a submit that crashed can leave it behind, in which case delete it to try again. Stop a submitted job with cancel_job. Not available on Windows, which cannot detach a process this way.

Examples

# Not run by check: it would start a real render.
if (FALSE) { # \dontrun{
submit_job("analyses/nb.boostmtree.lvef.boost.qmd")
} # }