diff options
| author | Junyang Qian <junyangq@databricks.com> | 2016-09-02 21:11:57 -0700 |
|---|---|---|
| committer | Shivaram Venkataraman <shivaram@cs.berkeley.edu> | 2016-09-02 21:11:57 -0700 |
| commit | d2fde6b72c4aede2e7edb4a7e6653fb1e7b19924 (patch) | |
| tree | ee12945473f547082f6c31ce4312d596bc106e97 /R/pkg | |
| parent | e6132a6cf10df8b12af8dd8d1a2c563792b5cc5a (diff) | |
| download | spark-d2fde6b72c4aede2e7edb4a7e6653fb1e7b19924.tar.gz spark-d2fde6b72c4aede2e7edb4a7e6653fb1e7b19924.tar.bz2 spark-d2fde6b72c4aede2e7edb4a7e6653fb1e7b19924.zip | |
[SPARKR][MINOR] Fix docs for sparkR.session and count
## What changes were proposed in this pull request?
This PR tries to add some more explanation to `sparkR.session`. It also modifies doc for `count` so when grouped in one doc, the description doesn't confuse users.
## How was this patch tested?
Manual test.
Author: Junyang Qian <junyangq@databricks.com>
Closes #14942 from junyangq/fixSparkRSessionDoc.
Diffstat (limited to 'R/pkg')
| -rw-r--r-- | R/pkg/R/functions.R | 3 | ||||
| -rw-r--r-- | R/pkg/R/group.R | 2 | ||||
| -rw-r--r-- | R/pkg/R/sparkR.R | 6 |
3 files changed, 7 insertions, 4 deletions
diff --git a/R/pkg/R/functions.R b/R/pkg/R/functions.R index 369b1d00d9..ceedbe7671 100644 --- a/R/pkg/R/functions.R +++ b/R/pkg/R/functions.R @@ -444,7 +444,8 @@ setMethod("cosh", #' Returns the number of items in a group #' -#' Returns the number of items in a group. This is a column aggregate function. +#' This can be used as a column aggregate function with \code{Column} as input, +#' and returns the number of items in a group. #' #' @rdname count #' @name count diff --git a/R/pkg/R/group.R b/R/pkg/R/group.R index e3479ef5fa..17f5283abe 100644 --- a/R/pkg/R/group.R +++ b/R/pkg/R/group.R @@ -57,7 +57,7 @@ setMethod("show", "GroupedData", #' Count #' -#' Count the number of rows for each group. +#' Count the number of rows for each group when we have \code{GroupedData} input. #' The resulting SparkDataFrame will also contain the grouping columns. #' #' @return A SparkDataFrame. diff --git a/R/pkg/R/sparkR.R b/R/pkg/R/sparkR.R index de53b0bf79..15afe01c24 100644 --- a/R/pkg/R/sparkR.R +++ b/R/pkg/R/sparkR.R @@ -314,8 +314,10 @@ sparkRHive.init <- function(jsc = NULL) { #' Get the existing SparkSession or initialize a new SparkSession. #' -#' Additional Spark properties can be set (...), and these named parameters take priority over -#' over values in master, appName, named lists of sparkConfig. +#' SparkSession is the entry point into SparkR. \code{sparkR.session} gets the existing +#' SparkSession or initializes a new SparkSession. +#' Additional Spark properties can be set in \code{...}, and these named parameters take priority +#' over values in \code{master}, \code{appName}, named lists of \code{sparkConfig}. #' #' For details on how to initialize and use SparkR, refer to SparkR programming guide at #' \url{http://spark.apache.org/docs/latest/sparkr.html#starting-up-sparksession}. |