diff options
| author | junyangq <qianjunyang@gmail.com> | 2016-09-13 21:01:03 -0700 |
|---|---|---|
| committer | Shivaram Venkataraman <shivaram@cs.berkeley.edu> | 2016-09-13 21:01:03 -0700 |
| commit | a454a4d86bbed1b6988da0a0e23b3e87a1a16340 (patch) | |
| tree | c9f3c943a5c397afa211b473c5012933816bfb05 /R/create-docs.sh | |
| parent | 37b93f54e89332b6b77bb02c1c2299614338fd7c (diff) | |
| download | spark-a454a4d86bbed1b6988da0a0e23b3e87a1a16340.tar.gz spark-a454a4d86bbed1b6988da0a0e23b3e87a1a16340.tar.bz2 spark-a454a4d86bbed1b6988da0a0e23b3e87a1a16340.zip | |
[SPARK-17317][SPARKR] Add SparkR vignette
## What changes were proposed in this pull request?
This PR tries to add a SparkR vignette, which works as a friendly guidance going through the functionality provided by SparkR.
## How was this patch tested?
Manual test.
Author: junyangq <qianjunyang@gmail.com>
Author: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
Author: Junyang Qian <junyangq@databricks.com>
Closes #14980 from junyangq/SPARKR-vignette.
Diffstat (limited to 'R/create-docs.sh')
| -rwxr-xr-x | R/create-docs.sh | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/R/create-docs.sh b/R/create-docs.sh index d2ae160b50..0dfba22463 100755 --- a/R/create-docs.sh +++ b/R/create-docs.sh @@ -17,11 +17,13 @@ # limitations under the License. # -# Script to create API docs for SparkR -# This requires `devtools` and `knitr` to be installed on the machine. +# Script to create API docs and vignettes for SparkR +# This requires `devtools`, `knitr` and `rmarkdown` to be installed on the machine. # After running this script the html docs can be found in # $SPARK_HOME/R/pkg/html +# The vignettes can be found in +# $SPARK_HOME/R/pkg/vignettes/sparkr_vignettes.html set -o pipefail set -e @@ -43,4 +45,9 @@ Rscript -e 'libDir <- "../../lib"; library(SparkR, lib.loc=libDir); library(knit popd +# render creates SparkR vignettes +Rscript -e 'library(rmarkdown); paths <- .libPaths(); .libPaths(c("lib", paths)); Sys.setenv(SPARK_HOME=tools::file_path_as_absolute("..")); render("pkg/vignettes/sparkr-vignettes.Rmd"); .libPaths(paths)' + +find pkg/vignettes/. -not -name '.' -not -name '*.Rmd' -not -name '*.md' -not -name '*.pdf' -not -name '*.html' -delete + popd |