Man pages for mskilab/Flow
Workflow and task management for genomics pipelines.

as.characterConvert task object to character, can be dumped to file and...
bcmdReturns vector of bsub (ie LSF) commands associated with this...
bjobsTracks down any LSF jobs associated with this Job object...
bkillKills any running LSF jobs associated with this Job object
brunRuns jobs on LSF
bsub_cmdbsub_cmd
cConcatenates Job objects built from the same Task
cachecaches .rds copy of job object to standard location...
chmodchmods Job output directories Chmods outputs of jobs (by...
cmdGets vector of command line calls associated with the jobs in...
coresGets cores associated with the jobs in the Job object
cores-setSets cores associated with the jobs in the Job object
dedupdedup
dirsreturns list of character vectors containing the contents of...
entitiesreturns original keyed data.table of entities associated with...
errreturns vector of paths to stderr files associated with this...
file.dirfile.dir
file.namefile.name
FlowFlow
FlowAnnotationCreates an entity-specific annotation object (ie a path or...
FlowAnnotation-classClass to represent an entity-specific annotation (ie a path...
Flow-classClass representing a collection of tasks
FlowLiteralCreates object representing a literal argument to a task (ie...
FlowLiteral-classClass to represent a literal argument to a task (ie a static...
FlowOutputConstructs an object representing the wiring of a regexp on a...
FlowOutput-classClass representing the wiring of a regexp on a job output...
gresGets queue or partition associated with the jobs in the Job...
gres-setSets qos associated with the jobs in the Job object
idsreturns vector of entity ids associated with this Job objedct
inputsreturns keyed data.table of inputs annotation associated with...
io_cGets ionice -c
io_c-setSets ionice parameters associated with Job object
io_nGets ionice -n
io_n-setSets ionice parameters associated with Job object
jnameReturns character vector of job names associated with this...
JobConstructs a job object from a Task and keyed data.table of...
Job-classClass representing a set of jobs, each which is the...
keyRetrieves the entity key associated with this Job object
lengthreturns length of this Job object
memGets max memory associated with the jobs in the Job object
mem-setSets max memory associated with the jobs in the Job object
moduleClass to implement modules, which are standalone pieces of...
Module-classModule class
module-taskGets module associated with a Task
moremore
nice_valGets nice value
nice_val-setSets nice value associated with job object
normalizePathnormalizePath
nowToggles whether to force jobs to run now
now-setSets now param associated with the jobs in the Job object
outreturns vector of paths to stdout files associated with this...
outdirGets vector of output directories associated with the jobs in...
outputsreturns keyed data.table of output entity annotations...
parse.infoparse.info
plot.Flowplot.Flow
purgepurges all output / run directories associated with this Job...
qcmdReturns vector of qsub (ie SGE) commands associated with this...
qjobsTracks down any sGE jobs associated with this Job object...
qkillKills any running SGE jobs associated with this Job object
qos-setSets qos associated with the jobs in the Job object
qpriorGets qprior value
qprior-setSets qprior parameter associated with job object
qrunRuns jobs on LSF
qsub_cmdqsub_cmd
queueGets queue associated with the jobs in the Job object
queue-setSets queue associated with the jobs in the Job object
refreshrefreshes .rds copy of job object from standard location...
reportRetrieves a data.table reporting detailed runtime stats...
reset.jobreset.job Reset a job with different params
rrbindrrbind
runRuns jobs as local commands from shell via R system calls
scmdReturns vector of ssub (ie Slurm) commands associated with...
setwdchanges directory to the directory of the job
silentrun expression without any printed output execute expression...
sjobsTracks down any slurm jobs associated with this Job object...
skillKills any running Slurm jobs associated with this Job object
Slurmizeupdates cmd.sh to run on slurm
sniffsniff
srunRuns jobs on Slurm
ssub_cmdssub_cmd
statusReturns character vector of status of jobs in this Job...
status.inforeturns vector of more detailed statuses associated with jobs...
subcaches .rds copy of job object to standard location...
sub-.FlowFlow subset
tailftailf
taskObject representing a task, which is a wiring of a module...
Task-classS4 class for 'Task'
tasksreturns original keyed data.table of entities associated with...
timeGets max time limit associated with job object
time-setSets max time limit associated with the jobs in the Job...
updateupdates Job status This method checks inputs for updates to...
viewtaskor Flow Task object
xml2taskMakes a best attempt to convert a firehose xml task...
mskilab/Flow documentation built on Jan. 12, 2023, 8:31 a.m.