get_matlab: Find matlab path

Description Usage Arguments Value Examples

View source: R/matlab_script.R

Description

This tries to find matlab's path using a system which command, and then, if not found, looks at getOption("matlab.path"). If not path is found, it fails.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
get_matlab(
  try_defaults = TRUE,
  desktop = FALSE,
  splash = FALSE,
  display = FALSE,
  jvm = TRUE,
  figure_windows = TRUE,
  wait = TRUE,
  single_thread = FALSE
)

Arguments

try_defaults

(logical) If matlab is not found from Sys.which, and matlab.path not found, then try some default PATHs for Linux and OS X.

desktop

Should desktop be active for MATLAB?

splash

Should splash be active for MATLAB?

display

Should display be active for MATLAB?

jvm

should JVM be be loaded? If FALSE, then -nojvm

figure_windows

should figure windows be enabled. If not, -noFigureWindows will be called

wait

Should R wait for the command to finish. Both passed to system and adds the -wait flag.

single_thread

Should the flag -singleCompThread be executed to limit MATLAB to a single computational thread?

Value

Character of command for matlab

Examples

1
2
3
if (have_matlab()) {
get_matlab()
}

muschellij2/matlabr documentation built on July 4, 2020, 12:59 p.m.