launchBatch: Launching batch

View source: R/launchBatch.R

launchBatchR Documentation

Launching batch

Description

Convenient way to launch an R file in batch mode.

Usage

launchBatch(
  file,
  path = ".",
  dirBatch = NULL,
  operator = NULL,
  add.Rout = TRUE,
  add.lis = TRUE,
  add.options = "",
  rm.newfile = FALSE
)

Arguments

file

the name of the file. character.

path

the path to the directory containing the file. character.

dirBatch

If no NULL, the name of a directory where to store the .lis and .Rout. character.

operator

the command used to launch the batch. character.

add.Rout

Should a file .Rout be generated. character.

add.lis

Should a file .liss be generated.character.

add.options

Additional options to be used to launch the batch. character.

rm.newfile

Should the copy of the original file be removed after completion of the function? character.

Details

If the directory specified for argument dirBatch does not exist, it will be automatically generated (provided it corresponds to a valid path). Before launching the batch, first a copy of the file is made. It is named with the prefix launchBatch- and, if any, will automatically overwrite the existing file. Then the command for generating the .lis is added to the file and the batch is launched.

Value

the output of the shell when lauching the batch. character.


bozenne/butils documentation built on Oct. 14, 2023, 6:19 a.m.