Package 'cronR'

Make a simple cron job

Description

Generate a cron job, and pass it to crontab.

The goal is to be able to translate simple English statements of intent to the actual cron statement that could execute that intent. For example,

"I want to run a job daily at 7AM."

is simply

cron_add(<command>, "daily", at="7AM")

Another example, "I want to run a job on the 15th of every month."

is

cron_add(<command>, "monthly", days_of_month="15th")

Usage

cron_add(
  command,
  frequency = "daily",
  at,
  days_of_month,
  days_of_week,
  months,
  id,
  tags = "",
  description = "",
  dry_run = FALSE,
  user = "",
  ask = TRUE,
  env = character()
)

cronjob(
  command,
  frequency = "daily",
  at,
  days_of_month,
  days_of_week,
  months,
  id,
  tags = "",
  description = "",
  dry_run = FALSE,
  user = "",
  ask = TRUE,
  env = character()
)

Arguments

command	A command to execute.
frequency	A character string equal to one of "minutely", "hourly", "daily", "monthly", or "yearly". Or any complex cron schedule - see the examples.
at	The actual time of day at which to execute the command. When unspecified, we default to "3AM", when the command is to be run less frequently than "hourly".
days_of_month	Optional; the day(s) of the month on which we execute the command.
days_of_week	Optional; the day(s) of the week on which we execute the command.
months	Optional; the month(s) of the year on which we execute the command.
id	An id, or name, to give to the cronjob task, for easier revision in the future.
tags	A set of tags, used for easy listing and retrieval of cron jobs.
description	A short description of the job, and its purpose.
dry_run	Boolean; if TRUE we do not submit the cron job; instead we return the parsed text that would be submitted as a cron job.
user	The user whose cron jobs we wish to examine.
ask	Boolean; show prompt asking for validation
env	Named character; set environment variables for a cron job. Specify 'Sys.getenv()' to inherit the variables from the current R session.

Examples

f   <- system.file(package = "cronR", "extdata", "helloworld.R")
cmd <- cron_rscript(f)
cmd

cron_add(command = cmd, frequency = 'minutely', 
  id = 'test1', description = 'My process 1', tags = c('lab', 'xyz'))
cron_add(command = cmd, frequency = 'daily', at='7AM', id = 'test2')
cron_njobs()

cron_ls()
cron_clear(ask=TRUE)
cron_ls()

cmd <- cron_rscript(f, rscript_args = c("productx", "arg2", "123"))
cmd
cron_add(cmd, frequency = 'minutely', id = 'job1', description = 'Customers')
cron_add(cmd, frequency = 'hourly', id = 'job2', description = 'Weather')
cron_add(cmd, frequency = 'hourly', id = 'job3', days_of_week = c(1, 2))
cron_add(cmd, frequency = 'hourly', id = 'job4', at = '00:20', days_of_week = c(1, 2))
cron_add(cmd, frequency = 'daily', id = 'job5', at = '14:20')
cron_add(cmd, frequency = 'daily', id = 'job6', at = '14:20', days_of_week = c(0, 3, 5))
cron_add(cmd, frequency = 'daily', id = 'job7', at = '23:59', days_of_month = c(1, 30))
cron_add(cmd, frequency = 'monthly', id = 'job8', at = '10:30', 
  days_of_month = 'first', days_of_week = '*')
cron_add(cmd, frequency = '@reboot', id = 'job9', description = 'Good morning')
cron_add(cmd, frequency = '*/15 * * * *', id = 'job10', description = 'Every 15 min')   
cron_ls()
cron_clear(ask=TRUE)

---

Clear all cron jobs

Description

Clear all cron jobs

Usage

cron_clear(ask = TRUE, user = "")

Arguments

ask	Boolean; ask before removal?
user	The user whose crontab we are clearing.

Examples

f   <- system.file(package = "cronR", "extdata", "helloworld.R")
cmd <- cron_rscript(f)
cron_add(command = cmd, frequency = 'minutely', id = 'test1', description = 'My process 1')
cron_add(command = cmd, frequency = 'daily', at="7AM", id = 'test2', description = 'My process 2')
cron_njobs()

cron_ls()
cron_clear(ask=TRUE)
cron_ls()

---

Load a crontab from file

Description

Load a crontab from file

Usage

cron_load(file, user = "", ask = TRUE)

Arguments

file	The file location of a crontab.
user	The user for whom we will be loading a crontab.
ask	Boolean; show prompt asking for validation

---

List the contents of a crontab

Description

We only list the contents that are handeld by cronR.

Usage

cron_ls(id, tags, user = "")

Arguments

id	Return cron jobs with a certain id.
tags	Return cron jobs with a certain (set of) tags.
user	The user's crontab to display

Examples

cron_ls()

---

List the number of rCron cron jobs

Description

List the number of rCron cron jobs

Usage

cron_njobs(user = "")

Arguments

user	The user whose cron jobs we wish to examine.

Examples

cron_njobs()

---

Remove a cronjob

Description

Use this command to remove a cron job added by cron_add.

Usage

cron_rm(id, dry_run = FALSE, user = "", ask = TRUE)

Arguments

id	A set of ids, partially matched from the beginning, we wish to remove. We only remove the id if it is uniquely matched in the file.
dry_run	Boolean; if TRUE we do not submit the cron job; instead we return the parsed text that would be submitted as a cron job.
user	The user whose crontab we will be modifying.
ask	Boolean; show prompt asking for validation

Examples

f   <- system.file(package = "cronR", "extdata", "helloworld.R")
cmd <- cron_rscript(f)
cron_add(command = cmd, frequency = 'minutely', id = 'test1', description = 'My process 1')
cron_njobs()
cron_ls()
cron_rm(id = "test1")
cron_njobs()
cron_ls()

---

Create a command to execute an R script which can be scheduled with cron_add

Description

Create a command to execute an R script which can be scheduled with cron_add where the stdout and stderr will be passed on to a log

Usage

cron_rscript(
  rscript,
  rscript_log = sprintf("%s%s.log", tools::file_path_sans_ext(rscript),
    ifelse(log_timestamp, "-`date+\\%Y-\\%m-\\%d_\\%H:\\%M:\\%S`", "")),
  rscript_args = "",
  cmd = file.path(Sys.getenv("R_HOME"), "bin", "Rscript"),
  log_append = TRUE,
  log_timestamp = FALSE,
  workdir = NULL,
  type = c("default", "output_on_error", "output_always"),
  ...
)

Arguments

rscript	character string with the path to an R script with .r or .R extension
rscript_log	where to put the log, defaults in the same directory and with the same filename as rscript but with extension .log.
rscript_args	a character string with extra arguments to be passed on to Rscript
cmd	path to Rscript. Defaults to R_HOME/bin/Rscript
log_append	logical, append to the log or overwrite
log_timestamp	logical, indicating to append a timestamp to the script log filename in the default argument of rscript_log. This will only work if the path to the log folder does not contain spaces.
workdir	If provided, Rscript will be run from this working directory.
type	a character string specifying the type of command to generate: default The command will send stdout and stderr to the log file but will never output these streams. output_always The command will send stdout and stderr to the log file in addition to emitting them as an output. output_on_error The command will send stdout and stderr to the log file, and it will emit them as an output when the R script has a non-zero exit status.
...	further arguments, specific to argument type, currently not used

Value

a character string with a command which can e.g. be put as a cronjob for running a simple R script at specific timepoints

Examples

f <- system.file(package = "cronR", "extdata", "helloworld.R")
cron_rscript(f)
cron_rscript(f, rscript_args = "more arguments passed on to the call")
cron_rscript(f, rscript_args = c("more", "arguments", "passed", "on", "to", "the", "call"))

cron_rscript(f, log_append = FALSE)
cron_rscript(f, log_append = TRUE)
cron_rscript(f, log_append = FALSE, log_timestamp = TRUE)

## run from home directory
cron_rscript(f, workdir = normalizePath("~"))

## other non-default options for type
cron_rscript(f, type = "output_on_error")
cron_rscript(f, type = "output_always")

---

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

Description

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

Usage

cron_rstudioaddin(RscriptRepository = Sys.getenv("CRON_LIVE", unset = getwd()))

Arguments

RscriptRepository

path to the folder where R scripts will be copied to and launched from, and by default log files will be written to. Defaults to the current working directory or in case it is set, the path set in the CRON_LIVE environment variable.

Value

the return of runGadget

Examples

## Not run: 
cron_rstudioaddin()

## End(Not run)

---

Save the current crontab

Description

Save the current crontab

Usage

cron_save(file, overwrite = FALSE, user = "")

Arguments

file	The file location at which you wish to save your crontab.
overwrite	logical; should we overwrite the file at path file if it already exists?
user	The user whose cron jobs we will be saving.

See Also

file.copy

Examples

## Not run: 
cron_add(command = cron_rscript(system.file(package = "cronR", "extdata", "helloworld.R")), 
  frequency = 'minutely', id = 'test1', description = 'My process 1')
cron_save(file="crontab_backup", overwrite=TRUE)
cron_clear()
cron_load(file="crontab_backup")

## End(Not run)

---