h2o.init: Connect to H2O and Install R Package

Description

Connects to a running H2O instance and checks the local H2O R package is the correct version (i.e. that the version of the R package and the version of H2O are the same).

Usage

h2o.init(ip = "127.0.0.1", port = 54321, startH2O = TRUE, forceDL = FALSE, Xmx = "1g", 
        beta = FALSE, license = NULL)

Arguments

Object of class "character" representing the IP address of the server where H2O is running.

port

Object of class "numeric" representing the port number of the H2O server.

startH2O

(Optional) A logical value indicating whether to start the H2O launcher GUI if no connection with H2O is detected. This is only possible if ip = "localhost" or ip = "127.0.0.1".

forceDL

(Optional) A logical value indicating whether to force download of the H2O executable. Defaults to FALSE, so the executable will only be downloaded if it does not already exist in the h2o R library resources directory h2o/java/h2o.jar.

Xmx

(Optional) A string specifying the maximum size, in bytes, of the memory allocation pool to H2O. This value must a multiple of 1024 greater than 2MB. Append the letter m or M to indicate megabytes, or g or G to indicate gigabytes.

beta

(Optional) A logical value indicating whether H2O should be launch in beta mode.

license

(Optional) A string value specifying the full path of the license file.

Value

Once the package is successfully installed, this method will load it and return a H2OClient object containing the IP address and port number of the H2O server. See the http://docs.0xdata.com/userguide/topR.html{H2O R package documentation} for more details, or type ??h2o in the R console.

Details

This method first checks if H2O is connectible. If it cannot connect and startH2O = TRUE with IP of localhost, it will attempt to start an instance of H2O with IP = localhost, port = 54321. Otherwise, it stops immediately with an error. When initializing H2O locally, this method searches for h2o.jar in the R library resources (system.file("java", "h2o.jar", package = "h2o")), and if the file does not exist, it will automatically attempt to download the correct version from Amazon S3. The user must have Internet access for this process to be successful. Once connected, the method checks to see if the local H2O R package version matches the version of H2O running on the server. If there is a mismatch and the user indicates she wishes to upgrade, it will remove the local H2O R package and download/install the H2O R package from the server.

Examples

Run this code

# Try to create a localhost connection to H2O. 
localH2O = h2o.init()
localH2O = h2o.init(ip = "localhost", port = 54321)
localH2O = h2o.init(ip = "localhost", port = 54321, startH2O = FALSE)