[SPARK-20889] SparkR grouped documentation for Column methods

• Type: Documentation
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.1
• Fix Version/s: 2.3.0
• Component/s: SparkR
• Labels: documentation
• Target Version/s: 2.3.0
• Assignee: Wayne Zhang
• Reporter: Wayne Zhang
• Shepherd: Felix Cheung
• Created: 25/May/17 17:25
• Updated: 30/Jun/17 21:10
• Resolved: 20/Jun/17 02:42

Description

Group the documentation of individual methods defined for the Column class. This aims to create the following improvements:

• Centralized documentation for easy navigation (user can view multiple related methods on one single page).
• Reduced number of items in Seealso.
• Betters examples using shared data. This avoids creating a data frame for each function if they are documented separately. And more importantly, user can copy and paste to run them directly!
• Cleaner structure and much fewer Rd files (remove a large number of Rd files).
• Remove duplicated definition of param (since they share exactly the same argument).
• No need to write meaningless examples for trivial functions (because of grouping).

Issue Links

• is related to: SPARK-18825 Eliminate duplicate links in SparkR API doc index
• links to: [Github] Pull Request #18025 (actuaryzhang)
• links to: [Github] Pull Request #18114 (actuaryzhang)
• links to: [Github] Pull Request #18366 (actuaryzhang)
• links to: [Github] Pull Request #18371 (actuaryzhang)
• links to: [Github] Pull Request #18422 (actuaryzhang)
• links to: [Github] Pull Request #18448 (actuaryzhang)
• links to: [Github] Pull Request #18458 (actuaryzhang)
• links to: [Github] Pull Request #18481 (actuaryzhang)
• links to: [Github] Pull Request #18493 (actuaryzhang)