Skip to content
Snippets Groups Projects
Commit 1b7eab74 authored by felixcheung's avatar felixcheung Committed by Reynold Xin
Browse files

[SPARK-12148][SPARKR] fix doc after renaming DataFrame to SparkDataFrame

## What changes were proposed in this pull request?

Fixed inadvertent roxygen2 doc changes, added class name change to programming guide
Follow up of #12621

## How was this patch tested?

manually checked

Author: felixcheung <felixcheung_m@hotmail.com>

Closes #12647 from felixcheung/rdataframe.
parent b45819ac
No related branches found
No related tags found
No related merge requests found
...@@ -25,7 +25,7 @@ setOldClass("jobj") ...@@ -25,7 +25,7 @@ setOldClass("jobj")
#' @title S4 class that represents a SparkDataFrame #' @title S4 class that represents a SparkDataFrame
#' @description DataFrames can be created using functions like \link{createDataFrame}, #' @description DataFrames can be created using functions like \link{createDataFrame},
#' \link{read.json}, \link{table} etc. #' \link{read.json}, \link{table} etc.
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname SparkDataFrame #' @rdname SparkDataFrame
#' @docType class #' @docType class
#' #'
...@@ -68,7 +68,7 @@ dataFrame <- function(sdf, isCached = FALSE) { ...@@ -68,7 +68,7 @@ dataFrame <- function(sdf, isCached = FALSE) {
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname printSchema #' @rdname printSchema
#' @name printSchema #' @name printSchema
#' @export #' @export
...@@ -93,7 +93,7 @@ setMethod("printSchema", ...@@ -93,7 +93,7 @@ setMethod("printSchema",
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname schema #' @rdname schema
#' @name schema #' @name schema
#' @export #' @export
...@@ -117,7 +117,7 @@ setMethod("schema", ...@@ -117,7 +117,7 @@ setMethod("schema",
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' @param extended Logical. If extended is False, explain() only prints the physical plan. #' @param extended Logical. If extended is False, explain() only prints the physical plan.
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname explain #' @rdname explain
#' @name explain #' @name explain
#' @export #' @export
...@@ -148,7 +148,7 @@ setMethod("explain", ...@@ -148,7 +148,7 @@ setMethod("explain",
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname isLocal #' @rdname isLocal
#' @name isLocal #' @name isLocal
#' @export #' @export
...@@ -173,7 +173,7 @@ setMethod("isLocal", ...@@ -173,7 +173,7 @@ setMethod("isLocal",
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' @param numRows The number of rows to print. Defaults to 20. #' @param numRows The number of rows to print. Defaults to 20.
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname showDF #' @rdname showDF
#' @name showDF #' @name showDF
#' @export #' @export
...@@ -198,7 +198,7 @@ setMethod("showDF", ...@@ -198,7 +198,7 @@ setMethod("showDF",
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname show #' @rdname show
#' @name show #' @name show
#' @export #' @export
...@@ -225,7 +225,7 @@ setMethod("show", "SparkDataFrame", ...@@ -225,7 +225,7 @@ setMethod("show", "SparkDataFrame",
#' #'
#' @param x A SparkDataFrame #' @param x A SparkDataFrame
#' #'
#' @family SparkSparkDataFrame functions #' @family SparkDataFrame functions
#' @rdname dtypes #' @rdname dtypes
#' @name dtypes #' @name dtypes
#' @export #' @export
......
...@@ -384,10 +384,11 @@ You can inspect the search path in R with [`search()`](https://stat.ethz.ch/R-ma ...@@ -384,10 +384,11 @@ You can inspect the search path in R with [`search()`](https://stat.ethz.ch/R-ma
# Migration Guide # Migration Guide
## Upgrading From SparkR 1.5.x to 1.6 ## Upgrading From SparkR 1.5.x to 1.6.x
- Before Spark 1.6, the default mode for writes was `append`. It was changed in Spark 1.6.0 to `error` to match the Scala API. - Before Spark 1.6.0, the default mode for writes was `append`. It was changed in Spark 1.6.0 to `error` to match the Scala API.
## Upgrading From SparkR 1.6.x to 2.0 ## Upgrading From SparkR 1.6.x to 2.0
- The method `table` has been removed and replaced by `tableToDF`. - The method `table` has been removed and replaced by `tableToDF`.
- The class `DataFrame` has been renamed to `SparkDataFrame` to avoid name conflicts.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment