Skip to content
This repository was archived by the owner on Jul 20, 2018. It is now read-only.

Commit a0ca860

Browse files
authored
Merge pull request #8 from h2oai/NG_readmefix
Add info about integration with h2o package
2 parents d35ae27 + fb55c20 commit a0ca860

File tree

1 file changed

+36
-18
lines changed

1 file changed

+36
-18
lines changed

README.md

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,42 @@ This package implements basic functionality (creating an H2OContext, showing the
2828
* [H2O.ai website](http://h2o.ai)
2929
* Code for the example shown below is [here](https://github.com/h2oai/rsparkling/blob/master/inst/examples/example_rsparkling.R).
3030

31+
## Integration
32+
33+
`rsparkling` requires certain integration settings (specific Sparkling Water versions must match specific Spark and H2O versions).
34+
Refer to integration info below.
35+
36+
| Spark Version | Sparkling Water Version | H2O Version |
37+
| ------------- | ----------------------- | ----------- |
38+
| 2.0 | 2.0.0 | 3.10.0.7 |
39+
| | 2.0.1 | 3.10.0.10 |
40+
| | 2.0.2 | 3.10.0.10 |
41+
| | 2.0.3 | 3.10.1.2 |
42+
| | | |
43+
| 1.6 | 1.6.1 | 3.10.0.7 |
44+
| | 1.6.2 | 3.8.1.3 |
45+
| | 1.6.3 | 3.8.2.3 |
46+
| | 1.6.4 | 3.8.2.4 |
47+
| | 1.6.5 | 3.8.2.6 |
48+
| | 1.6.6 | 3.10.0.4 |
49+
| | 1.6.7 | 3.10.0.6 |
50+
| | 1.6.8 | 3.10.0.7 |
51+
52+
The example below will use Spark version 2.0, Sparkling Water version 2.0.3, & H2O version 3.10.1.2.
3153

3254
## Installation
3355

34-
The **rsparkling** R package requires the **h2o** and **sparklyr** R packages to run.
56+
The **rsparkling** R package requires the **sparklyr** and **h2o** R packages to run.
3557

36-
### Install h2o
58+
### Install sparklyr
59+
60+
We recommend the latest stable version of [sparklyr](http://spark.rstudio.com/index.html).
61+
62+
```r
63+
install.packages("sparklyr")
64+
```
3765

38-
Today (Sept. 2016, the initial github release of rsparkling) you must use H2O R package version [3.10.0.6](http://h2o-release.s3.amazonaws.com/h2o/rel-turing/6/index.html#R) (H2O "Turing" release, build 6), since that version of H2O is embedded in rsparkling. This will be more flexible in the future.
66+
### Install h2o
3967

4068
```r
4169
# The following two commands remove any previously installed H2O packages for R.
@@ -48,19 +76,11 @@ for (pkg in pkgs) {
4876
if (! (pkg %in% rownames(installed.packages()))) { install.packages(pkg) }
4977
}
5078

51-
# Now we download, install and initialize the H2O package for R.
52-
install.packages("h2o", type = "source", repos = "http://h2o-release.s3.amazonaws.com/h2o/rel-turing/6/R")
53-
```
54-
55-
### Install sparklyr
56-
57-
We recommend the latest stable version of [sparklyr](http://spark.rstudio.com/index.html).
58-
59-
```r
60-
install.packages("sparklyr")
79+
# Now we download, install, and initialize the H2O package for R.
80+
# In this case we are using rel-turnbull 2 (3.10.1.2).
81+
install.packages("h2o", type = "source", repos = "http://h2o-release.s3.amazonaws.com/h2o/rel-turnbull/2/R")
6182
```
6283

63-
6484
### Install rsparkling
6585

6686
The latest version of rsparkling on CRAN can be installed as follows:
@@ -83,8 +103,6 @@ library(devtools)
83103
devtools::install_github("h2oai/rsparkling", ref = "master")
84104
```
85105

86-
87-
88106
## Connecting to Spark
89107

90108
If Spark needs to be installed, that can be done using the following sparklyr command:
@@ -94,10 +112,10 @@ library(sparklyr)
94112
spark_install(version = "2.0.0")
95113
```
96114

97-
The call to `options(rsparkling.sparklingwater.version = ...)` will globally set up a specific Sparkling Water version, which is the version of Sparkling Water that will be called in the `library(rsparkling)` command.
115+
The call to `options(rsparkling.sparklingwater.version = ...)` will globally set up a specific Sparkling Water version, which is the version of Sparkling Water that will be called in the `library(rsparkling)` command.
98116

99117
``` r
100-
options(rsparkling.sparklingwater.version = "2.0.0") # Using Sparkling Water 2.0.0
118+
options(rsparkling.sparklingwater.version = "2.0.3") # Using Sparkling Water 2.0.3
101119
library(rsparkling)
102120
```
103121

0 commit comments

Comments
 (0)