Schedule R Scripts/Processes with the Windows Task Scheduler

Description

Schedule R scripts/processes with the Windows task scheduler. This allows R users to automate R processes on specific timepoints from R itself. The package is basically a wrapper around the Schtasks.exe functionality. More information about schtasks can be found at https://msdn.microsoft.com/en-us/library/windows/desktop/bb736357 or at the doc folder inside this package.

Launch an RStudio addin which allows to schedule an Rscript interactively.

Description

Launch an RStudio addin which allows to schedule an Rscript interactively.

Usage

taskschedulerAddin(RscriptRepository, debug = TRUE)

Arguments

Value

the return of runGadget

Examples

## Not run: 
taskschedulerAddin()

## End(Not run)

Schedule an R script with the Windows task scheduler.

Description

Schedule an R script with the Windows task scheduler. E.g. daily, weekly, once, at startup, ... More information about the scheduling format can be found in the docs/schtasks.pdf file inside this package. The rscript file will be scheduled with Rscript.exe and the log of the run will be put in the .log file which can be found in the same directory as the location of the rscript

Usage

taskscheduler_create(
  taskname = basename(rscript),
  rscript,
  schedule = c("ONCE", "MONTHLY", "WEEKLY", "DAILY", "HOURLY", "MINUTE", "ONLOGON",
    "ONIDLE"),
  starttime = format(Sys.time() + 62, "%H:%M"),
  startdate = format(Sys.Date(), "%d/%m/%Y"),
  days = c("*", "MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN", 1:31),
  months = c("*", "JAN", "FEB", "MAR", "APR", "MAY", "JUN", "JUL", "AUG", "SEP", "OCT",
    "NOV", "DEC"),
  modifier,
  idletime = 60L,
  Rexe = file.path(Sys.getenv("R_HOME"), "bin", "Rscript.exe"),
  rscript_args = "",
  rscript_options = "",
  schtasks_extra = "",
  debug = FALSE,
  exec_path = ""
)

Arguments

Value

the system call to schtasks /Create

Examples

myscript <- system.file("extdata", "helloworld.R", package = "taskscheduleR")
cat(readLines(myscript), sep = "\n")

## Not run: 
## Run script once at a specific timepoint (within 62 seconds)
runon <- format(Sys.time() + 62, "%H:%M")
taskscheduler_create(taskname = "myfancyscript", rscript = myscript, 
 schedule = "ONCE", starttime = runon)
 
## Run every day at the same time on 09:10, starting from tomorrow on
## Mark: change the format of startdate to your locale if needed (e.g. US: %m/%d/%Y)
taskscheduler_create(taskname = "myfancyscriptdaily", rscript = myscript, 
 schedule = "DAILY", starttime = "09:10", startdate = format(Sys.Date()+1, "%d/%m/%Y"))
 
## Run every week on Sunday at 09:10
taskscheduler_create(taskname = "myfancyscript_sun", rscript = myscript, 
  schedule = "WEEKLY", starttime = "09:10", days = 'SUN')

## Run every 5 minutes, starting from 10:40
taskscheduler_create(taskname = "myfancyscript_5min", rscript = myscript,
  schedule = "MINUTE", starttime = "10:40", modifier = 5)
  
## Run every minute, giving some command line arguments which can be used in the script itself
taskscheduler_create(taskname = "myfancyscript_withargs_a", rscript = myscript,
  schedule = "MINUTE", rscript_args = "productxyz 20160101")
taskscheduler_create(taskname = "myfancyscript_withargs_b", rscript = myscript,
  schedule = "MINUTE", rscript_args = c("productabc", "20150101"))
  
alltasks <- taskscheduler_ls()
subset(alltasks, TaskName %in% c("myfancyscript", "myfancyscriptdaily"))
# The field TaskName might have been different on Windows with non-english language locale

taskscheduler_delete(taskname = "myfancyscript")
taskscheduler_delete(taskname = "myfancyscriptdaily")
taskscheduler_delete(taskname = "myfancyscript_sun")
taskscheduler_delete(taskname = "myfancyscript_5min")
taskscheduler_delete(taskname = "myfancyscript_withargs_a")
taskscheduler_delete(taskname = "myfancyscript_withargs_b")

## Have a look at the log
mylog <- system.file("extdata", "helloworld.log", package = "taskscheduleR")
cat(readLines(mylog), sep = "\n")

## End(Not run)

Delete a specific task which was scheduled in the Windows task scheduler.

Description

Delete a specific task which was scheduled in the Windows task scheduler.

Usage

taskscheduler_delete(taskname)

Arguments

Value

the system call to schtasks /Delete

Examples

## Not run: 
x <- taskscheduler_ls()
x
# The field TaskName might have been different on Windows with non-english language locale
task <- x$TaskName[1] 
taskscheduler_delete(taskname = task)

## End(Not run)

Get all the tasks which are currently scheduled at the Windows task scheduler.

Description

Get all the tasks which are currently scheduled at the Windows task scheduler.

Usage

taskscheduler_ls(encoding = "UTF-8", ...)

Arguments

Value

a data.frame with scheduled tasks as returned by schtasks /Query for which the Taskname or second column in the dataset the preceding \ is removed

Examples

x <- taskscheduler_ls()
x

Immediately run a specific task available in the Windows task scheduler.

Description

Immediately run a specific task available in the Windows task scheduler.

Usage

taskscheduler_runnow(taskname)

Arguments

Value

the system call to schtasks /Run

Examples

## Not run: 
myscript <- system.file("extdata", "helloworld.R", package = "taskscheduleR")
taskscheduler_create(taskname = "myfancyscript", rscript = myscript, 
 schedule = "ONCE", starttime = format(Sys.time() + 10*60, "%H:%M"))

taskscheduler_runnow("myfancyscript")
Sys.sleep(5)
taskscheduler_stop("myfancyscript")


taskscheduler_delete(taskname = "myfancyscript")

## End(Not run)

Stop the run of a specific task which is running in the Windows task scheduler.

Description

Stop the run of a specific task which is running in the Windows task scheduler.

Usage

taskscheduler_stop(taskname)

Arguments

Value

the system call to schtasks /End

Examples

## Not run: 
myscript <- system.file("extdata", "helloworld.R", package = "taskscheduleR")
taskscheduler_create(taskname = "myfancyscript", rscript = myscript, 
 schedule = "ONCE", starttime = format(Sys.time() + 10*60, "%H:%M"))

taskscheduler_runnow("myfancyscript")
Sys.sleep(5)
taskscheduler_stop("myfancyscript")


taskscheduler_delete(taskname = "myfancyscript")

## End(Not run)