writeLogFile: Write a job log file

Description Usage Arguments Value Author(s) Examples

View source: R/writeLogFile.R

Description

Writes a log file of the status of all jobs that are currently executing on the grid. If all jobs are done, the log will indicate which ran successfully and which did not. If not, the log file will show the amount of time all jobs have been running, along with the number of jobs of each status.

Usage

1
2
3
4
5
writeLogFile(jobStatuses, 
  startingTime, 
  logFileName = "jobstatus.log", 
  statusNames = c("PEND", "RUN", "DONE", "EXIT", "SUSPEND", "UNKWN"), 
  workingPath = getwd()) 

Arguments

jobStatuses

(Required) A vector of strings of statuses of all currently running jobs

startingTime

(Required) A time at which the jobs started running

logFileName

(Optional) Name of the file to write to ("jobstatus.log" by default)

statusNames

(Optional) A vector of strings that contain all possible names of statuses that jobs could be in. By default, this is "PEND", "RUN", "DONE", "EXIT", "SUSPEND" and "UNKWN"

workingPath

(Optional) The working directory in which to create the log file. By default, the current working directory is used

Value

None.

Author(s)

Mike K Smith mstoolkit@googlemail.com

Examples

1
2
3
4
5
6
 ## Not run:  
    jstatuses <- sample(c("PEND", "RUN", "DONE", "EXIT"), 10, replace = TRUE)
    writeLogFile(jstatuses, Sys.time())
    file.show( "jobstatus.log" )
  
## End(Not run)

MSToolkit documentation built on May 2, 2019, 6:30 p.m.