-
Notifications
You must be signed in to change notification settings - Fork 29k
[SPARK-16142] [R] group naiveBayes method docs in a single Rd #13877
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| # Makes predictions from a generalized linear model produced by glm() or spark.glm(), | ||
| # similarly to R's predict(). | ||
| #' | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this fixes small style issues from #13820
|
Test build #61128 has finished for PR 13877 at commit
|
| #' @return \code{spark.naiveBayes} returns a fitted naive Bayes model | ||
| #' @rdname spark.naiveBayes | ||
| #' @name spark.naiveBayes | ||
| #' @seealso e1071: \url{https://cran.r-project.org/web/packages/e1071/} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we want to hide the url?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
roxygen2 only supports raw url links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could use the \link tag as discussed in http://stackoverflow.com/questions/25489042/linking-to-other-packages-in-documentation-in-roxygen2-in-r
|
The new document in the screenshot looks pretty good to me. |
## What changes were proposed in this pull request? This PR groups `spark.naiveBayes`, `summary(NB)`, `predict(NB)`, and `write.ml(NB)` into a single Rd. ## How was this patch tested? Manually checked generated HTML doc. See attached screenshots.   Author: Xiangrui Meng <[email protected]> Closes #13877 from mengxr/SPARK-16142. (cherry picked from commit 4a40d43) Signed-off-by: Xiangrui Meng <[email protected]>
|
Merged into master and branch-2.0. Thanks for reviewing! |
What changes were proposed in this pull request?
This PR groups
spark.naiveBayes,summary(NB),predict(NB), andwrite.ml(NB)into a single Rd.How was this patch tested?
Manually checked generated HTML doc. See attached screenshots.