[SPARK-10118][SparkR][Docs] Improve SparkR API docs for 1.5 release

[yu-iskw]

cc: @shivaram

Summary

• Modify @tdname of expression functions. i.e. ascii: @rdname functions => @rdname ascii
• Replace the dynamical function definitions to the static ones because of thir documentations.

Generated PDF File

https://drive.google.com/file/d/0B9biIZIU47lLX2t6ZjRoRnBTSEU/view?usp=sharing

JIRA

[SPARK-10118] Improve SparkR API docs for 1.5 release - ASF JIRA

[SparkQA]

Test build #41435 has finished for PR 8386 at commit 343719b.

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

[yu-iskw]

@shivaram could you review it?

[shivaram]

Thanks @yu-iskw for this change and also for sending the PDF. One question I have is if there is any way we can change the documentation from appearing as floor,Column-method to just floor. I think we can do this with aliases, but I haven't tried this out.

cc @davies

[yu-iskw]

@shivaram it seems that we can change them with @name. I'll try it.

[yu-iskw]

@shivaram These are the gists of floor.Rd to show the difference if using @name or not. If there are any issues, I can revert the update.

• floor.Rd with @name
• floor.Rd without @name

[SparkQA]

Test build #41485 has finished for PR 8386 at commit 934a558.

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

[shivaram]

@yu-iskw Thanks this is looking great ! I tried this locally and ran into one small problem while running knitr (using R/create-docs.sh). It needs the following diff to work correctly -- Can you add this to the PR ?

-Rscript -e 'library(SparkR, lib.loc="../../lib"); library(knitr); knit_rd("SparkR")'
+Rscript -e 'libDir <- "../../lib"; library(SparkR, lib.loc=libDir); library(knitr); knit_rd("SparkR", links = tools::findHTMLlinks(paste(libDir, "SparkR", sep="/")))'

Also we should do a similar cleanup of other methods in columns.R and DataFrame.R but we can do it in a separate PR.

[yu-iskw]

@shivaram sure. I have just modified it.

[SparkQA]

Test build #41494 has finished for PR 8386 at commit 8a09abb.

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

[shivaram]

Thanks @yu-iskw -- LGTM. Merging this

[yu-iskw]

Thank you for merging it!