Skip to content
Snippets Groups Projects
  • Kai Jiang's avatar
    8a911051
    [MINOR][R][DOC] Fix R documentation generation instruction. · 8a911051
    Kai Jiang authored
    ## 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.
    8a911051
    History
    [MINOR][R][DOC] Fix R documentation generation instruction.
    Kai Jiang authored
    ## 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.
DOCUMENTATION.md 474 B

SparkR Documentation

SparkR documentation is generated by using in-source comments and annotated by using roxygen2. After making changes to the documentation and generating man pages, you can run the following from an R console in the SparkR home directory

library(devtools)
devtools::document(pkg="./pkg", roclets=c("rd"))

You can verify if your changes are good by running

R CMD check pkg/