0001 ---
0002 license: |
0003 Licensed to the Apache Software Foundation (ASF) under one or more
0004 contributor license agreements. See the NOTICE file distributed with
0005 this work for additional information regarding copyright ownership.
0006 The ASF licenses this file to You under the Apache License, Version 2.0
0007 (the "License"); you may not use this file except in compliance with
0008 the License. You may obtain a copy of the License at
0009
0010 http://www.apache.org/licenses/LICENSE-2.0
0011
0012 Unless required by applicable law or agreed to in writing, software
0013 distributed under the License is distributed on an "AS IS" BASIS,
0014 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0015 See the License for the specific language governing permissions and
0016 limitations under the License.
0017 ---
0018
0019 # SparkR Documentation
0020
0021 SparkR documentation is generated by using in-source comments and annotated by using
0022 [`roxygen2`](https://cran.r-project.org/web/packages/roxygen2/index.html). After making changes to the documentation and generating man pages,
0023 you can run the following from an R console in the SparkR home directory
0024 ```R
0025 library(devtools)
0026 devtools::document(pkg="./pkg", roclets=c("rd"))
0027 ```
0028 You can verify if your changes are good by running
0029
0030 R CMD check pkg/