aboutsummaryrefslogtreecommitdiff
path: root/R/DOCUMENTATION.md
blob: 931d01549b265bf58d17df5660496610eaad7c57 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
# SparkR Documentation

SparkR documentation is generated using in-source comments annotated using using
`roxygen2`. After making changes to the documentation, to generate 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/