useLogFile: FUSION R command line interface - Write comments or other...

In bmcgaughey1/fusionwrapr: R Interface to FUSION-LTK Command Line Programs

FUSION R command line interface – Write comments or other lines to command file

Description

useLogFile writes code to a command file (batch file) to set the log file for FUSION tools. The normal behavior is to write output to a log file in the FUSION install folder (LTKmaster.log).

Usage

useLogFile(logFile = NULL, cmdFile = NULL, logClear = FALSE, cmdClear = FALSE)

Arguments

logFile	character: Name of the log file.
cmdFile	character: contains the name of the file to which commands should be written.
logClear	boolean: add a line to the command file to delete the logFile before setting the environment variable for the log file.
cmdClear	boolean: indicates file for command should be deleted before the command line is written. Use this option with caution as it will wipe out the content of the command file.

Details

Note that the logFile can contain spaces (the folder name, file name, or both). However, using spaces is not recommended and may cause problems. If you include a folder name, you can use the backslash or forwardslash characters as the path separator.

To reset logging behavior to use the log file in the FUSION install folder, use useLogFile("").

Value

invisible boolean indicating success or failure

Examples

## Not run: 
useLogFile("NewLog.log", "test.bat", logClear = TRUE)

## End(Not run)

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