Skip to content

[SPARK-16142] [R] group naiveBayes method docs in a single Rd#13877

Closed
mengxr wants to merge 1 commit into
apache:masterfrom
mengxr:SPARK-16142
Closed

[SPARK-16142] [R] group naiveBayes method docs in a single Rd#13877
mengxr wants to merge 1 commit into
apache:masterfrom
mengxr:SPARK-16142

Conversation

@mengxr

@mengxr mengxr commented Jun 23, 2016

Copy link
Copy Markdown
Contributor

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.

screen shot 2016-06-23 at 2 11 00 pm

screen shot 2016-06-23 at 2 11 15 pm

@mengxr

mengxr commented Jun 23, 2016

Copy link
Copy Markdown
Contributor Author

cc: @junyangq @shivaram

Comment thread R/pkg/R/mllib.R
# Makes predictions from a generalized linear model produced by glm() or spark.glm(),
# similarly to R's predict().
#'

Copy link
Copy Markdown
Contributor Author

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

@SparkQA

SparkQA commented Jun 23, 2016

Copy link
Copy Markdown

Test build #61128 has finished for PR 13877 at commit 41814a7.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

Comment thread R/pkg/R/mllib.R
#' @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/}

Copy link
Copy Markdown
Contributor

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?

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shivaram

Copy link
Copy Markdown
Contributor

The new document in the screenshot looks pretty good to me.

asfgit pushed a commit that referenced this pull request Jun 24, 2016
## 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.

![screen shot 2016-06-23 at 2 11 00 pm](https://cloud.githubusercontent.com/assets/829644/16320452/a5885e92-394c-11e6-994f-2ab5cddad86f.png)

![screen shot 2016-06-23 at 2 11 15 pm](https://cloud.githubusercontent.com/assets/829644/16320455/aad1f6d8-394c-11e6-8ef4-13bee989f52f.png)

Author: Xiangrui Meng <meng@databricks.com>

Closes #13877 from mengxr/SPARK-16142.

(cherry picked from commit 4a40d43)
Signed-off-by: Xiangrui Meng <meng@databricks.com>
@mengxr

mengxr commented Jun 24, 2016

Copy link
Copy Markdown
Contributor Author

Merged into master and branch-2.0. Thanks for reviewing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants