8a9110510c
## What changes were proposed in this pull request? changes in R/README.md - Make step of generating SparkR document more clear. - link R/DOCUMENTATION.md from R/README.md - turn on some code syntax highlight in R/README.md ## How was this patch tested? local test Author: Kai Jiang <jiangkai@gmail.com> Closes #13488 from vectorijk/R-Readme.
13 lines
474 B
Markdown
13 lines
474 B
Markdown
# SparkR Documentation
|
|
|
|
SparkR documentation is generated by using in-source comments and annotated by using
|
|
[`roxygen2`](https://cran.r-project.org/web/packages/roxygen2/index.html). After making changes to the documentation and generating man pages,
|
|
you can run the following from an R console in the SparkR home directory
|
|
```R
|
|
library(devtools)
|
|
devtools::document(pkg="./pkg", roclets=c("rd"))
|
|
```
|
|
You can verify if your changes are good by running
|
|
|
|
R CMD check pkg/
|