Run a Spotfire Miner Worksheet

DESCRIPTION:

From the Spotfire S+ Server, runs a Spotfire Miner worksheet in batch mode. This function works only with the Spotfire S+ Server.

USAGE:

bd.run.iminer.worksheet(file, parameters=NULL, parameter.file=NULL, 
                        invalidate.nodes="all", runto.nodes="all", logfile=NULL,
                        append.log=F, print.messages=T, wsd.dir=NULL)

REQUIRED ARGUMENTS:

file
The name of the worksheet file to run. For example, myworksheet.imw.

OPTIONAL ARGUMENTS:

parameters
A named vector of strings, giving parameter names and values. For example, c(IN="infilename", OUT="outfilename")
parameter.file
The name of the file containing parameter values in Java properties format.
invalidate.nodes
The worksheet nodes to be invalidated before executing the worksheet.
runto.nodes
The worksheet nodes to "run to" to execute the worksheet. "all" specifies all nodes, "none" specifies no nodes, and vector of integers specifies a set of nodes.
logfile
The name of the file where detailed log messages are sent.
append.log
If TRUE, append a new log to the specified logfile.
print.messages
If TRUE, info messages are printed.
wsd.dir
The directory to use for the worksheet state.

VALUE:

Returns TRUE if the worksheet executed without any errors; otherwise FALSE.

SIDE EFFECTS:

Runs a Spotfire Miner worksheet only on the Spotfire S+ Server. It does not work with a desktop Spotfire S+ installation.

SEE ALSO:

EXAMPLES:

#  execute the worksheet "rwparam.imw" using the parameters defined 
#  in the file "rwparam.properties" using the worksheet directory 
#  "rwparam.wsd" located in the current working directory (or it will 
#  be created if it does not yet exist) 
bd.run.iminer.worksheet("rwparam.imw", parameter.file="rwparam.properties", wsd.dir="rwparam.wsd")
#  specify all parameters on the command line 
bd.run.iminer.worksheet("rwparam.imw",  parameters=c(IN="fuel.txt", NROW="5", OUT="fuel.xls")) 
#  where in the worksheet file, for example, %IN% is specified for File Name and 
#  %NROW% for End Row in a Read File node, and %OUT% is specified for File Name 
#  in a Write File node.