R_batch_sequence: Description of R_batch_sequence R6 class

In UNCDEPENdLab/fmri.pipeline: Analysis of fMRI Data on HPC clusters

Description of R_batch_sequence R6 class

Description

Description of R_batch_sequence R6 class

Description of R_batch_sequence R6 class

Methods

Public methods

• R_batch_sequence$new()

• R_batch_sequence$add()

• R_batch_sequence$submit()

• R_batch_sequence$generate()

• R_batch_sequence$get_job_ids()

• R_batch_sequence$clone()

---

Method new()

create a new R_batch_sequence object

Usage

R_batch_sequence$new(..., joblist = NULL)

Arguments

...

One or more R_batch_job objects to be run in sequence

joblist

Optional list of jobs to be used instead of ...

---

Method add()

add one or more R_batch_job objects to the sequence

Usage

R_batch_sequence$add(...)

Arguments

...

One or more R_batch_job objects to be added to sequence

---

Method submit()

submit the job sequence to the scheduler or local compute

Usage

R_batch_sequence$submit()

---

Method generate()

Calls each job's $generate() method so that scripts can be examined without running the sequence

Usage

R_batch_sequence$generate()

---

Method get_job_ids()

Return a named vector of the job ids for all jobs in this sequence

Usage

R_batch_sequence$get_job_ids()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

R_batch_sequence$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

UNCDEPENdLab/fmri.pipeline documentation built on April 3, 2025, 3:21 p.m.