initialize.dssrip: dssrip initialization

In eheisman/dssrip: DSS R Interface Project

dssrip initialization

Description

Starts a rJava JVM with configuration for dss's jar and dll files.

Usage

initialize.dssrip(
  pkgname = NULL,
  quietDSS = TRUE,
  parameters = options()[["dss_jvm_parameters"]],
  setJavaLoc = FALSE,
  verbose = TRUE,
  ...
)

Arguments

quietDSS	- if true, don't show 'Z' messages during opening, reading, and writing to a file.
parameters	list of options string to pass to JVM. (defaults to the option 'dss_jvm_parameters' or NULL)
setJavaLoc	- override Java location with one in config file. (untested)
verbose	- set to true for debuggering

Details

This method is typically called by the onLoad function when the package is imported. List of 'options' can be passed to this package via the R global 'options()' function: - 'dss_jvm_parameters' string passed to JVM when initialized, allowing memory settings to be altered or other JVM start-up options set. This is untested. - 'dss_override_location' file path to force dssrip to load a particular set of dss libraries. This is untested. - ‘dss_config_filename' filename that points to a jar_config.json file external to the package’s default configuration. - ‘dss_allowed_states' list, defaults to 'c(’tested')', filters config file to only allowed states. - 'dss_default_config', string, forces to only use config going by this 'name'.

Value

JVM initialization status - 0 if successful, positive for partial initialization, negative for failure. See ?.jinit

Author(s)

Evan Heisman

See Also

loadConfig

eheisman/dssrip documentation built on Feb. 10, 2024, 2:40 p.m.