Connect To DSS

Connect to DSS via the JVM.

Usage

dss_check_connection()

dss_require(
  dss_home = getOption("dss.home"),
  message_level = getOption("dss.messagelevel"),
  monolith = getOption("dss.monolith"),
  quietly = TRUE
)

dss_connect(
  dss_home = getOption("dss.home"),
  message_level = getOption("dss.messagelevel"),
  monolith = getOption("dss.monolith"),
  quietly = FALSE
)

Arguments

dss_home

The path to the HEC-DSS install folder.

message_level

An integer specifying the DSS message level. Default is 2L. Use 1L to suppress all messages from DSS.

monolith

If TRUE, connect to HEC-Monolith libraries.

quietly

If TRUE, suppress warnings regarding the JVM.

Details

both dss_connect() and dss_require() configure the JVM to use the HEC-DSS Java library. dss_require() is designed for use inside other packages; it returns FALSE and gives a warning (rather than an error as dss_connect() does) if the HEC-DSS Java library cannot be loaded correctly.

Java Virtual Machine Parameters

When working with very large DSS files, you may need to initialize the Java Virtual Machine (JVM) with a larger heap size. For more information see the help vignette: vignette("Java Virtual Machine Parameters", package = "dssrip2")

See also

dss_message_level() dss_install_monolith()