Use this feature only for running Spotfire Miner in batch mode on the Spotfire S+ Server. It does not work with desktop installations of Spotfire Miner or Spotfire S+. It must be run from a UNIX shell prompt.
Splus CMD IMBATCH [options] worksheetfile
name=value
format.
name=value
pairs.
(The entire list must be in single quotes, while each value
must be in double quotes; the name/value pair list can contain no spaces. For example: 'n1="v1",n2="v2"'.)
"all"
.
nodes
can be
"all"
for all nodes,
"none"
for no nodes,
or a comma- separated list of integers specifying nodes numbers:
"3,5,8"
.
The default is
"all"
.
<basename worksheetfile>_out.txt
).
<basename worksheetfile>
is the worksheetfile name stripped of possible directory path and extension.
(where=1)
,
making it if needed. If
--work
is not specified, a new randomly-named
directory is created for the working database.
IMBATCH
:
the S-PLUS working database, the worksheet directory, and the
temporary input file.
options(echo=T)
).
options(verbose=T)
).
--work
is ignored).
The first three items are automatically deleted after execution unless the --noclean argument in set. Or a permanent Spotfire S+ database can be specified with the --work argument, and a permanent worksheet directory can be specified by the --wsd argument.
The output file contains the status of executing the worksheet nodes, including error messages, if an error occurred.
Worksheet parameters can be specified in three ways:
(1) using the
--parameter
argument to set one parameter,
--parameter NROWS=70
(2) using the
--parameters
argument to set one or more parameters,
--parameters 'IN="fuel.txt",OUT="fuel.xls"'
(3) using the
--parameter.file
argument to specify the name of a file containing parameter settings,
--parameter.file rwparam.properties
A combination of these methods can be used when invoking IMBATCH.
S-PLUS is case sensitive. The word
IMBATCH
must be in all capital letters. This must be run from a
UNIX shell prompt
to execute.
IMBATCH
follows the code conventions of the single dash or double dash preceding single
character or character string options, respectively. That is, when you specify an option, if that option
is specified with a single character (for example,
h
for help), use
a single dash (-):
-h
. If the option is specified with a character string
(for example,
help
for help), use a double dash (--):
--help
.
Notice that the
--logfile
and
--appendlog
arguments are not the same as those used with the
SBATCH
and
START
commands. If
--logfile
is set when invoking
IMBATCH
, detailed Spotfire Miner information
will be written as the worksheet is executed, not Spotfire S+ messages.
Execution begins immediately after
IMBATCH
is invoked.
If you are on a UNIX system,
you might want to put the
IMBATCH
job in the background
or use the UNIX
at
(or
chron
) command to delay execution.
# 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) Splus CMD IMBATCH --pfile rwparam.properties --wsd rwparam.wsd rwparam.imw
# specify all parameters on the command line Splus CMD IMBATCH --parameters 'IN="fuel.txt",OUT="fuel.xls"' --parameter NROW=150 rwparam.imw # 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.