[MINOR][DOCS] Improve Running R Tests docs #18271

wangyum · 2017-06-12T03:03:06Z

What changes were proposed in this pull request?

Update Running R Tests dependence packages to:

R -e "install.packages(c('knitr', 'rmarkdown', 'testthat', 'e1071', 'survival'), repos='http://cran.us.r-project.org')"

How was this patch tested?

manual tests

SparkQA · 2017-06-12T03:26:27Z

Test build #77907 has finished for PR 18271 at commit 5643ab9.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

HyukjinKwon · 2017-06-12T03:35:32Z

docs/building-spark.md


 To run the SparkR tests you will need to install the R package `testthat`
-(run `install.packages(testthat)` from R shell).  You can run just the SparkR tests using
+(run `install.packages("testthat")` from R shell).  You can run just the SparkR tests using


Mind updating this contents to be consistent with the unit test part -
https://github.com/apache/spark/blob/7e0cd1d9b168286386f15e9b55988733476ae2bb/R/README.md#examples-unit-tests if it sounds making sense to you?

This also looks including specifying the mirror from where to download the package.

SparkQA · 2017-06-12T05:14:40Z

Test build #77911 has finished for PR 18271 at commit d715ae8.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

srowen · 2017-06-12T09:49:50Z

From trying to run the tests last week, I think more packages are actually needed. The DESCRIPTION file names: knitr, rmarkdown, testthat, e1071, survival
Let's suggest installing all of those.

felixcheung · 2017-06-13T05:05:05Z

docs/building-spark.md

-To run the SparkR tests you will need to install the R package `testthat`
-(run `install.packages(testthat)` from R shell).  You can run just the SparkR tests using
-the command:
+To run the SparkR tests you will need to install the [testthat](http://cran.r-project.org/web/packages/testthat/index.html) package first:


use https://cran.r-project.org/package=testthat instead

felixcheung · 2017-06-13T05:06:07Z

the list is on https://github.com/apache/spark/blob/master/R/pkg/DESCRIPTION#L20

SparkQA · 2017-06-13T07:57:20Z

Test build #77977 has finished for PR 18271 at commit 926137b.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

srowen · 2017-06-13T09:09:13Z

R/README.md

 ./bin/spark-submit examples/src/main/r/dataframe.R
 ```
-You can also run the unit tests for SparkR by running. You need to install the [testthat](http://cran.r-project.org/web/packages/testthat/index.html) package first:
+You can also run the unit tests for SparkR by running. You need to install the [knitr](https://cran.r-project.org/package=knitr), [rmarkdown](https://cran.r-project.org/package=rmarkdown), [testthat](https://cran.r-project.org/package=testthat), [e1071](https://cran.r-project.org/package=e1071) and [survival](https://cran.r-project.org/package=survival) packages first:


Rather than duplicate this information, I wonder if you can just link to http://spark.apache.org/docs/latest/building-spark.html#running-r-tests here ?

SparkQA · 2017-06-13T16:35:53Z

Test build #77995 has finished for PR 18271 at commit a2fd28a.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

srowen · 2017-06-13T16:41:41Z

R/README.md

-R -e 'install.packages("testthat", repos="http://cran.us.r-project.org")'
-./R/run-tests.sh
-```
+You can run the unit tests following [running-r-tests](http://spark.apache.org/docs/latest/building-spark.html#running-r-tests).


I think this will look funny; you want something like "You can run R unit tests by following the instructions under Running R Tests"

bdwyer2 · 2017-06-13T19:04:45Z

docs/building-spark.md

-the command:
+To run the SparkR tests you will need to install the [knitr](https://cran.r-project.org/package=knitr), [rmarkdown](https://cran.r-project.org/package=rmarkdown), [testthat](https://cran.r-project.org/package=testthat), [e1071](https://cran.r-project.org/package=e1071) and [survival](https://cran.r-project.org/package=survival) packages first:
+
+    R -e 'install.packages(c("knitr", "rmarkdown", "testthat", "e1071", "survival"), repos="http://cran.us.r-project.org")'


what about a more global mirror? (e.g. https://cloud.r-project.org/)

…er Running R Tests"

HyukjinKwon · 2017-06-14T00:15:12Z

R/README.md

-R -e 'install.packages("testthat", repos="http://cran.us.r-project.org")'
-./R/run-tests.sh
-```
+You can run R unit tests by following the instructions under [Running R Tests](http://spark.apache.org/docs/latest/building-spark.html#running-r-tests).


I am sorry, @wangyum, would you mind update https://github.com/wangyum/spark/blob/0da2f5b5b3ac122a2ba5b295b4ae8c4f4af02758/R/WINDOWS.md?

SparkQA · 2017-06-14T00:43:16Z

Test build #78013 has finished for PR 18271 at commit 0da2f5b.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

HyukjinKwon · 2017-06-14T03:20:31Z

For me, it looks good. I assume we consider #18271 (comment) but it looks fine as is too.

SparkQA · 2017-06-14T03:40:35Z

Test build #78021 has finished for PR 18271 at commit 4bc320e.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

srowen · 2017-06-14T07:41:20Z

R/WINDOWS.md

 4. Set the environment variable `HADOOP_HOME` to the full path to the newly created `hadoop` directory.

-5. Run unit tests for SparkR by running the command below. You need to install the [testthat](http://cran.r-project.org/web/packages/testthat/index.html) package first:
+5. Run unit tests for SparkR by running the command below. You need to install the [knitr](https://cran.r-project.org/package=knitr), [rmarkdown](https://cran.r-project.org/package=rmarkdown), [testthat](https://cran.r-project.org/package=testthat), [e1071](https://cran.r-project.org/package=e1071) and [survival](https://cran.r-project.org/package=survival) packages first:


OK, but again why duplicate this information? are there more locations this is repeated? we should just point to one location where these details are listed, to make sure they don't get out of sync

Windows is a little diffrence from Linux, so only link dependency package.
Linux:

R -e 'install.packages(c("knitr", "rmarkdown", "testthat", "e1071", "survival"), repos="http://cran.us.r-project.org")'

Windows:

R -e "install.packages(c('knitr', 'rmarkdown', 'testthat', 'e1071', 'survival'), repos='http://cran.us.r-project.org')"

SparkQA · 2017-06-14T09:50:34Z

Test build #78048 has finished for PR 18271 at commit 75cf0d8.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

felixcheung · 2017-06-14T16:28:25Z

+1 for not duplicating. You can change the command line to use " to make it work in both platforms

SparkQA · 2017-06-15T10:14:27Z

Test build #78096 has finished for PR 18271 at commit ff6415f.

This patch passes all tests.
This patch merges cleanly.
This patch adds no public classes.

wangyum · 2017-06-16T01:42:37Z

Removed the duplicating. It works both for Windows and linux:

R -e "install.packages(c('knitr', 'rmarkdown', 'testthat', 'e1071', 'survival'), repos='http://cran.us.r-project.org')"

srowen · 2017-06-16T10:04:11Z

Merged to master/2.2

## What changes were proposed in this pull request? Update Running R Tests dependence packages to: ```bash R -e "install.packages(c('knitr', 'rmarkdown', 'testthat', 'e1071', 'survival'), repos='http://cran.us.r-project.org')" ``` ## How was this patch tested? manual tests Author: Yuming Wang <[email protected]> Closes #18271 from wangyum/building-spark. (cherry picked from commit 45824fb) Signed-off-by: Sean Owen <[email protected]>

Improve docs

5643ab9

wangyum changed the title ~~[MINOR][DOCS] Improve docs to Running R Tests~~ [MINOR][DOCS] Improve Running R Tests docs Jun 12, 2017

HyukjinKwon reviewed Jun 12, 2017

View reviewed changes

Be consistent with examples-unit-tests and more cleaner

d715ae8

felixcheung reviewed Jun 13, 2017

View reviewed changes

Add more packages

926137b

srowen reviewed Jun 13, 2017

View reviewed changes

Remove duplicate info

a2fd28a

srowen reviewed Jun 13, 2017

View reviewed changes

bdwyer2 reviewed Jun 13, 2017

View reviewed changes

Update to "You can run R unit tests by following the instructions und…

0da2f5b

…er Running R Tests"

HyukjinKwon reviewed Jun 14, 2017

View reviewed changes

Update WINDOWS doc

4bc320e

srowen reviewed Jun 14, 2017

View reviewed changes

Link WINDOWS dependency packages.

75cf0d8

Unified

ff6415f

asfgit closed this in 45824fb Jun 16, 2017

[MINOR][DOCS] Improve Running R Tests docs #18271

[MINOR][DOCS] Improve Running R Tests docs #18271

Uh oh!

Conversation

wangyum commented Jun 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

How was this patch tested?

Uh oh!

SparkQA commented Jun 12, 2017

Uh oh!

HyukjinKwon Jun 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SparkQA commented Jun 12, 2017

Uh oh!

srowen commented Jun 12, 2017

Uh oh!

felixcheung Jun 13, 2017

Choose a reason for hiding this comment

Uh oh!

felixcheung commented Jun 13, 2017

Uh oh!

SparkQA commented Jun 13, 2017

Uh oh!

srowen Jun 13, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented Jun 13, 2017

Uh oh!

srowen Jun 13, 2017

Choose a reason for hiding this comment

Uh oh!

bdwyer2 Jun 13, 2017

Choose a reason for hiding this comment

Uh oh!

HyukjinKwon Jun 14, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented Jun 14, 2017

Uh oh!

HyukjinKwon commented Jun 14, 2017

Uh oh!

SparkQA commented Jun 14, 2017

Uh oh!

srowen Jun 14, 2017

Choose a reason for hiding this comment

Uh oh!

wangyum Jun 14, 2017

Choose a reason for hiding this comment

Uh oh!

SparkQA commented Jun 14, 2017

Uh oh!

felixcheung commented Jun 14, 2017 via email

Uh oh!

SparkQA commented Jun 15, 2017

Uh oh!

wangyum commented Jun 16, 2017

Uh oh!

srowen commented Jun 16, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

wangyum commented Jun 12, 2017 •

edited

Loading

HyukjinKwon Jun 12, 2017 •

edited

Loading