[jira] [Commented] (SPARK-16090) Improve method grouping in SparkR generated docs

["Xiangrui Meng (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SPARK-16090?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15341258#comment-15341258 ] 

Xiangrui Meng commented on SPARK-16090:
---------------------------------------

For ML methods, I'd like to propose the following grouping:

* spark.glm: spark.glm, glm, predict(GLM), summary(GLM), read/write.ml(GLM)
* spark.naiveBayes: spark.naiveBayes, predict(NB), summary(NB), read/write.ml(NB)
* spark.kmeans: spark.kmeans, predict(KM), summary(KM), read/write.ml(KM)
* spark.survreg: .spark.survreg, predict(SR), summary(SR), read/write.ml(SR)

Then put a separate doc page for each generic method, including predict, summary, read/write.ml, and link to the doc pages above using see also.

> Improve method grouping in SparkR generated docs
> ------------------------------------------------
>
>                 Key: SPARK-16090
>                 URL: https://issues.apache.org/jira/browse/SPARK-16090
>             Project: Spark
>          Issue Type: Improvement
>          Components: Documentation, SparkR
>    Affects Versions: 2.0.0
>            Reporter: Xiangrui Meng
>            Priority: Critical
>
> This JIRA follows the discussion on https://github.com/apache/spark/pull/13109 to improve method grouping in SparkR generated docs. Having one method per doc page is not an R convention. However, having many methods per doc page would hurt the readability. So a proper grouping would help. Since we use roxygen2 instead of writing Rd files directly, we should consider smaller groups to avoid confusion. 



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org