Matlab$startServer: Static method which starts a MATLAB server

Description

Static method which starts a MATLAB server on the local machine. Note that MATLAB v6 or later is required, since the MATLAB server relies on Java.

Usage

## Static method (use this):
## Matlab$startServer(matlab=getOption("matlab"), port=9999, minimize=TRUE,
##   options=c("nodesktop", "nodisplay", "nosplash"), workdir=".", ...)
## Don't use the below:
# S3 method for Matlab
startServer(this, matlab=getOption("matlab"), port=9999, minimize=TRUE,
  options=c("nodesktop", "nodisplay", "nosplash"), workdir=".", ...)

Value

Returns nothing.

Arguments

matlab: An optional character string specifying the name of the matlab command, if different from "matlab". An absolute path are possible.
port: An optional integer in [1023, 65535]. If given, the environment variable MATLABSERVER_PORT is set specifying which port the MATLAB server should listen to for clients trying to connect. The default port is 9999.
minimize: When starting MATLAB on Windows, it is always opened in a new window (see 1. The MATLAB server running in MATLAB). If this argument is TRUE, the new window is minimized, otherwise not. This argument is ignored on non-Windows systems.
options: A character vector of options used to call the MATLAB application.
workdir: The working directory to be used by MATLAB.
...: Not used.

Author

Henrik Bengtsson

Details

This method is currently supported on Windows and Unix systems. Other systems are untested, but might work anyway.

Note that this method will return immediately upon calling system() internally, i.e. you will not receive a return value telling whether MATLAB was successfully started or not.

To specify the full path to the matlab software set the matlab option, e.g. options(matlab = "/opt/bin/matlab6.1"). If no such option exists, the value "matlab" will be used.