[SPARK-16090] Improve method grouping in SparkR generated docs

• Type: Umbrella
• Status: Resolved
• Priority: Critical
• Resolution: Fixed
• Affects Version/s: 2.0.0
• Fix Version/s: 2.0.0
• Component/s: Documentation, SparkR
• Target Version/s: 2.0.0
• Assignee: Xiangrui Meng
• Reporter: Xiangrui Meng
• Created: 21/Jun/16 06:57
• Updated: 15/Jul/16 17:31
• Resolved: 15/Jul/16 17:31

Description

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.

Issue Links

• is related to: SPARK-15177 SparkR 2.0 QA: make SparkR model params and default values consistent with MLlib
• relates to: SPARK-15319 Fix SparkR doc layout for corr and other DataFrame stats functions

Sub-Tasks

• Group GLM-related methods in generated doc: Resolved
• Separate out statfunctions in generated R doc: Resolved
• Group k-means method in generated doc: Resolved
• Group naive Bayes methods in generated doc: Resolved
• Group survival analysis methods in generated doc: Resolved
• Add a separate Rd for ML generic methods: read.ml, write.ml, summary, predict: Resolved