setGlobalCommandOptions: FUSION R command line interface - Set global options to...

View source: R/CoreFunctions.R

setGlobalCommandOptionsR Documentation

FUSION R command line interface – Set global options to control the dispatch of commands.

Description

setGlobalCommandOptions sets environment variables local to the fusionwrapr package that control how individual commands are handled. Use of setGlobalCommandOptions can simplify testing of commands and the creation of batch files.

Usage

setGlobalCommandOptions(
  use64bit = NULL,
  runCmd = NULL,
  saveCmd = NULL,
  cmdFile = NULL,
  echoCmd = NULL
)

Arguments

use64bit

boolean: indicates 64-bit version of the program should be used.

runCmd

boolean: indicates command line should be executed.

saveCmd

boolean: indicates command line should be written to a file. If this is TRUE, you must also set cmdFile either in the global options or in individual command function calls.

cmdFile

character: contains the name of the file to which commands should be written.

echoCmd

boolean: indicates command line should be displayed.

Details

Default behavior for dispatching commands is use the 64-bit version of programs (if available) and run the commands without echoing them to the console.

Value

boolean TRUE

Examples

setGlobalCommandOptions(runCmd = FALSE)

bmcgaughey1/fusionwrapr documentation built on Dec. 1, 2024, 7:13 a.m.