wait_on_jobs: Given string pattern matching job name, wait while jobs are...

View source: R/wait_on_jobs.R

wait_on_jobsR Documentation

Given string pattern matching job name, wait while jobs are running or pending (SLURM)

Description

Given string pattern matching job name, wait while jobs are running or pending (SLURM)

Usage

wait_on_jobs(
  job_pattern,
  jobname_nchar = 50L,
  initial_sleep_sec = 5L,
  file_list = NULL,
  obj = NULL,
  resub = 0,
  perl = FALSE,
  dryrun = FALSE
)

Arguments

job_pattern

[regex] a (perl) regular expression - submitted to 'gnu grep' system commend

jobname_nchar

[int] (defualt: 50) how many characters of a JobName to display and search

initial_sleep_sec

[int] time to allow system time to find a submitted job

file_list

[path/list] list of paths to files to wait on

obj

[chr] checks if rhdf5::h5ls(file_list)$name exists

resub

[int] if 0, return message about failures if missing_list has any items, else return 1

dryrun

(default FALSE) if TRUE, only message and return system command, but do not submit

Value

[std_out] message to user

Examples

## Not run: 
wait_on_jobs(job_pattern = "my_job_name")

## End(Not run)

epi-sam/SamsElves documentation built on June 12, 2025, 7 a.m.