initAnchors: Initialize and Connect to anchors
In viadee/anchorsOnR: AnchorsOnR: High-Precision Model-Agnostic Explanations in R

Description Usage Arguments Details Value

By default, this method first checks if an anchors instance is available to connect to. If it cannot connect and startAnchors = TRUE, it will attempt to start an instance of anchors at localhost:6666. If an open ip and port of your choice are passed in, then this method will attempt to start an anchors instance at that specified ip port.

1 2	initAnchors(ip = "localhost", port = 6666, name = NA_character_, startAnchors = TRUE, explainer = NULL, forceDL = FALSE)

`ip`	Object of class `character` representing the IP address of the server where Anchors is running.
`port`	Object of class `numeric` representing the port number of the Anchors server.
`name`	(Optional) A `character` string representing the Anchors cluster name.
`startAnchors`	(Optional) A `logical` value indicating whether to try to start Anchors from R if no connection with Anchors is detected. This is only possible if `ip = "localhost"` or `ip = "127.0.0.1"`. If an existing connection is detected, R does not start Anchors.
`explainer`	An `explainer` object holding startup params for the server
`forceDL`	(Optional) A `logical` value indicating whether to force download of the RemoteModuleExtension executable. Defaults to FALSE, so the executable will only be downloaded if it does not already exist in the anchors R library resources directory `anchors/java/RemoteModuleExtension.jar`. This value is only used when R starts anchors.

When initializing anchors locally, this method searches for RemoteModuleExtension.jar in the R library resources (system.file("java", "RemoveModuleExtension.jar", package = "anchors")), and if the file does not exist, it will automatically attempt to download the correct version from Maven. The user must have Internet access for this process to be successful.

Attempts to start and/or connect to an Anchors instance.

this method will load and return a socketConnection

viadee/anchorsOnR documentation built on Nov. 22, 2019, 5:24 p.m.