http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/attach.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/attach.html b/site/docs/2.3.2/api/R/attach.html new file mode 100644 index 0000000..3d0058b --- /dev/null +++ b/site/docs/2.3.2/api/R/attach.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Attach SparkDataFrame to R search path</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for attach,SparkDataFrame-method {SparkR}"><tr><td>attach,SparkDataFrame-method {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Attach SparkDataFrame to R search path</h2> + +<h3>Description</h3> + +<p>The specified SparkDataFrame is attached to the R search path. This means that +the SparkDataFrame is searched by R when evaluating a variable, so columns in +the SparkDataFrame can be accessed by simply giving their names. +</p> + + +<h3>Usage</h3> + +<pre> +## S4 method for signature 'SparkDataFrame' +attach(what, pos = 2L, + name = deparse(substitute(what), backtick = FALSE), + warn.conflicts = TRUE) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>what</code></td> +<td> +<p>(SparkDataFrame) The SparkDataFrame to attach</p> +</td></tr> +<tr valign="top"><td><code>pos</code></td> +<td> +<p>(integer) Specify position in search() where to attach.</p> +</td></tr> +<tr valign="top"><td><code>name</code></td> +<td> +<p>(character) Name to use for the attached SparkDataFrame. Names +starting with package: are reserved for library.</p> +</td></tr> +<tr valign="top"><td><code>warn.conflicts</code></td> +<td> +<p>(logical) If TRUE, warnings are printed about conflicts +from attaching the database, unless that SparkDataFrame contains an object</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>attach since 1.6.0 +</p> + + +<h3>See Also</h3> + +<p><a href="../../base/html/detach.html">detach</a> +</p> +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="cache.html">cache</a></code>, +<code><a href="checkpoint.html">checkpoint</a></code>, <code><a href="coalesce.html">coalesce</a></code>, +<code><a href="collect.html">collect</a></code>, <code><a href="columns.html">colnames</a></code>, +<code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D attach(irisDf) +##D summary(Sepal_Width) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html>
http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/avg.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/avg.html b/site/docs/2.3.2/api/R/avg.html new file mode 100644 index 0000000..1306740 --- /dev/null +++ b/site/docs/2.3.2/api/R/avg.html @@ -0,0 +1,67 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: avg</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for avg {SparkR}"><tr><td>avg {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>avg</h2> + +<h3>Description</h3> + +<p>Aggregate function: returns the average of the values in a group. +</p> + + +<h3>Usage</h3> + +<pre> +avg(x, ...) + +## S4 method for signature 'Column' +avg(x) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>Column to compute on or a GroupedData object.</p> +</td></tr> +<tr valign="top"><td><code>...</code></td> +<td> +<p>additional argument(s) when <code>x</code> is a GroupedData object.</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>avg since 1.4.0 +</p> + + +<h3>See Also</h3> + +<p>Other aggregate functions: <code><a href="column_aggregate_functions.html">column_aggregate_functions</a></code>, +<code><a href="corr.html">corr</a></code>, <code><a href="count.html">count</a></code>, +<code><a href="cov.html">cov</a></code>, <code><a href="first.html">first</a></code>, +<code><a href="last.html">last</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: avg(df$c) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/awaitTermination.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/awaitTermination.html b/site/docs/2.3.2/api/R/awaitTermination.html new file mode 100644 index 0000000..b8a65a2 --- /dev/null +++ b/site/docs/2.3.2/api/R/awaitTermination.html @@ -0,0 +1,84 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: awaitTermination</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for awaitTermination {SparkR}"><tr><td>awaitTermination {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>awaitTermination</h2> + +<h3>Description</h3> + +<p>Waits for the termination of the query, either by <code>stopQuery</code> or by an error. +</p> + + +<h3>Usage</h3> + +<pre> +awaitTermination(x, timeout = NULL) + +## S4 method for signature 'StreamingQuery' +awaitTermination(x, timeout = NULL) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a StreamingQuery.</p> +</td></tr> +<tr valign="top"><td><code>timeout</code></td> +<td> +<p>time to wait in milliseconds, if omitted, wait indefinitely until <code>stopQuery</code> +is called or an error has occured.</p> +</td></tr> +</table> + + +<h3>Details</h3> + +<p>If the query has terminated, then all subsequent calls to this method will return TRUE +immediately. +</p> + + +<h3>Value</h3> + +<p>TRUE if query has terminated within the timeout period; nothing if timeout is not +specified. +</p> + + +<h3>Note</h3> + +<p>awaitTermination(StreamingQuery) since 2.2.0 +</p> +<p>experimental +</p> + + +<h3>See Also</h3> + +<p>Other StreamingQuery methods: <code><a href="explain.html">explain</a></code>, +<code><a href="isActive.html">isActive</a></code>, <code><a href="lastProgress.html">lastProgress</a></code>, +<code><a href="queryName.html">queryName</a></code>, <code><a href="status.html">status</a></code>, +<code><a href="stopQuery.html">stopQuery</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: awaitTermination(sq, 10000) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/between.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/between.html b/site/docs/2.3.2/api/R/between.html new file mode 100644 index 0000000..320ec74 --- /dev/null +++ b/site/docs/2.3.2/api/R/between.html @@ -0,0 +1,55 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: between</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> +</head><body> + +<table width="100%" summary="page for between {SparkR}"><tr><td>between {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>between</h2> + +<h3>Description</h3> + +<p>Test if the column is between the lower bound and upper bound, inclusive. +</p> + + +<h3>Usage</h3> + +<pre> +between(x, bounds) + +## S4 method for signature 'Column' +between(x, bounds) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a Column</p> +</td></tr> +<tr valign="top"><td><code>bounds</code></td> +<td> +<p>lower and upper bounds</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>between since 1.5.0 +</p> + + +<h3>See Also</h3> + +<p>Other colum_func: <code><a href="alias.html">alias</a></code>, <code><a href="cast.html">cast</a></code>, +<code><a href="endsWith.html">endsWith</a></code>, <code><a href="otherwise.html">otherwise</a></code>, +<code><a href="over.html">over</a></code>, <code><a href="startsWith.html">startsWith</a></code>, +<code><a href="substr.html">substr</a></code> +</p> + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/broadcast.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/broadcast.html b/site/docs/2.3.2/api/R/broadcast.html new file mode 100644 index 0000000..83e6a2e --- /dev/null +++ b/site/docs/2.3.2/api/R/broadcast.html @@ -0,0 +1,118 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: broadcast</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for broadcast {SparkR}"><tr><td>broadcast {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>broadcast</h2> + +<h3>Description</h3> + +<p>Return a new SparkDataFrame marked as small enough for use in broadcast joins. +</p> + + +<h3>Usage</h3> + +<pre> +broadcast(x) + +## S4 method for signature 'SparkDataFrame' +broadcast(x) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a SparkDataFrame.</p> +</td></tr> +</table> + + +<h3>Details</h3> + +<p>Equivalent to <code>hint(x, "broadcast")</code>. +</p> + + +<h3>Value</h3> + +<p>a SparkDataFrame. +</p> + + +<h3>Note</h3> + +<p>broadcast since 2.3.0 +</p> + + +<h3>See Also</h3> + +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="cache.html">cache</a></code>, <code><a href="checkpoint.html">checkpoint</a></code>, +<code><a href="coalesce.html">coalesce</a></code>, <code><a href="collect.html">collect</a></code>, +<code><a href="columns.html">colnames</a></code>, <code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D df <- createDataFrame(mtcars) +##D avg_mpg <- mean(groupBy(createDataFrame(mtcars), "cyl"), "mpg") +##D +##D head(join(df, broadcast(avg_mpg), df$cyl == avg_mpg$cyl)) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/cache.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/cache.html b/site/docs/2.3.2/api/R/cache.html new file mode 100644 index 0000000..e5d8f28 --- /dev/null +++ b/site/docs/2.3.2/api/R/cache.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Cache</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for cache {SparkR}"><tr><td>cache {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Cache</h2> + +<h3>Description</h3> + +<p>Persist with the default storage level (MEMORY_ONLY). +</p> + + +<h3>Usage</h3> + +<pre> +cache(x) + +## S4 method for signature 'SparkDataFrame' +cache(x) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>A SparkDataFrame</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>cache since 1.4.0 +</p> + + +<h3>See Also</h3> + +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="checkpoint.html">checkpoint</a></code>, +<code><a href="coalesce.html">coalesce</a></code>, <code><a href="collect.html">collect</a></code>, +<code><a href="columns.html">colnames</a></code>, <code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D path <- "path/to/file.json" +##D df <- read.json(path) +##D cache(df) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/cacheTable.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/cacheTable.html b/site/docs/2.3.2/api/R/cacheTable.html new file mode 100644 index 0000000..7bdfefb --- /dev/null +++ b/site/docs/2.3.2/api/R/cacheTable.html @@ -0,0 +1,65 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Cache Table</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for cacheTable {SparkR}"><tr><td>cacheTable {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Cache Table</h2> + +<h3>Description</h3> + +<p>Caches the specified table in-memory. +</p> + + +<h3>Usage</h3> + +<pre> +## Default S3 method: +cacheTable(tableName) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>tableName</code></td> +<td> +<p>the qualified or unqualified name that designates a table. If no database +identifier is provided, it refers to a table in the current database.</p> +</td></tr> +</table> + + +<h3>Value</h3> + +<p>SparkDataFrame +</p> + + +<h3>Note</h3> + +<p>cacheTable since 1.4.0 +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D path <- "path/to/file.json" +##D df <- read.json(path) +##D createOrReplaceTempView(df, "table") +##D cacheTable("table") +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/cancelJobGroup.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/cancelJobGroup.html b/site/docs/2.3.2/api/R/cancelJobGroup.html new file mode 100644 index 0000000..e3c3416 --- /dev/null +++ b/site/docs/2.3.2/api/R/cancelJobGroup.html @@ -0,0 +1,55 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Cancel active jobs for the specified group</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for cancelJobGroup {SparkR}"><tr><td>cancelJobGroup {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Cancel active jobs for the specified group</h2> + +<h3>Description</h3> + +<p>Cancel active jobs for the specified group +</p> + + +<h3>Usage</h3> + +<pre> +## Default S3 method: +cancelJobGroup(groupId) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>groupId</code></td> +<td> +<p>the ID of job group to be cancelled</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>cancelJobGroup since 1.5.0 +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D cancelJobGroup("myJobGroup") +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/cast.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/cast.html b/site/docs/2.3.2/api/R/cast.html new file mode 100644 index 0000000..d67c18c --- /dev/null +++ b/site/docs/2.3.2/api/R/cast.html @@ -0,0 +1,72 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Casts the column to a different data type.</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for cast {SparkR}"><tr><td>cast {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Casts the column to a different data type.</h2> + +<h3>Description</h3> + +<p>Casts the column to a different data type. +</p> + + +<h3>Usage</h3> + +<pre> +cast(x, dataType) + +## S4 method for signature 'Column' +cast(x, dataType) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a Column.</p> +</td></tr> +<tr valign="top"><td><code>dataType</code></td> +<td> +<p>a character object describing the target data type. +See +<a href="https://spark.apache.org/docs/latest/sparkr.html#data-type-mapping-between-r-and-spark"> +Spark Data Types</a> for available data types.</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>cast since 1.4.0 +</p> + + +<h3>See Also</h3> + +<p>Other colum_func: <code><a href="alias.html">alias</a></code>, +<code><a href="between.html">between</a></code>, <code><a href="endsWith.html">endsWith</a></code>, +<code><a href="otherwise.html">otherwise</a></code>, <code><a href="over.html">over</a></code>, +<code><a href="startsWith.html">startsWith</a></code>, <code><a href="substr.html">substr</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D cast(df$age, "string") +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/checkpoint.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/checkpoint.html b/site/docs/2.3.2/api/R/checkpoint.html new file mode 100644 index 0000000..08a462f --- /dev/null +++ b/site/docs/2.3.2/api/R/checkpoint.html @@ -0,0 +1,119 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: checkpoint</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for checkpoint {SparkR}"><tr><td>checkpoint {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>checkpoint</h2> + +<h3>Description</h3> + +<p>Returns a checkpointed version of this SparkDataFrame. Checkpointing can be used to truncate the +logical plan, which is especially useful in iterative algorithms where the plan may grow +exponentially. It will be saved to files inside the checkpoint directory set with +<code>setCheckpointDir</code> +</p> + + +<h3>Usage</h3> + +<pre> +checkpoint(x, eager = TRUE) + +## S4 method for signature 'SparkDataFrame' +checkpoint(x, eager = TRUE) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>A SparkDataFrame</p> +</td></tr> +<tr valign="top"><td><code>eager</code></td> +<td> +<p>whether to checkpoint this SparkDataFrame immediately</p> +</td></tr> +</table> + + +<h3>Value</h3> + +<p>a new checkpointed SparkDataFrame +</p> + + +<h3>Note</h3> + +<p>checkpoint since 2.2.0 +</p> + + +<h3>See Also</h3> + +<p><a href="setCheckpointDir.html">setCheckpointDir</a> +</p> +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="cache.html">cache</a></code>, +<code><a href="coalesce.html">coalesce</a></code>, <code><a href="collect.html">collect</a></code>, +<code><a href="columns.html">colnames</a></code>, <code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D setCheckpointDir("/checkpoint") +##D df <- checkpoint(df) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/clearCache.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/clearCache.html b/site/docs/2.3.2/api/R/clearCache.html new file mode 100644 index 0000000..b1a18e4 --- /dev/null +++ b/site/docs/2.3.2/api/R/clearCache.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Clear Cache</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for clearCache {SparkR}"><tr><td>clearCache {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Clear Cache</h2> + +<h3>Description</h3> + +<p>Removes all cached tables from the in-memory cache. +</p> + + +<h3>Usage</h3> + +<pre> +## Default S3 method: +clearCache() +</pre> + + +<h3>Note</h3> + +<p>clearCache since 1.4.0 +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D clearCache() +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/clearJobGroup.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/clearJobGroup.html b/site/docs/2.3.2/api/R/clearJobGroup.html new file mode 100644 index 0000000..0d3e527 --- /dev/null +++ b/site/docs/2.3.2/api/R/clearJobGroup.html @@ -0,0 +1,45 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Clear current job group ID and its description</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for clearJobGroup {SparkR}"><tr><td>clearJobGroup {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Clear current job group ID and its description</h2> + +<h3>Description</h3> + +<p>Clear current job group ID and its description +</p> + + +<h3>Usage</h3> + +<pre> +## Default S3 method: +clearJobGroup() +</pre> + + +<h3>Note</h3> + +<p>clearJobGroup since 1.5.0 +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D clearJobGroup() +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/coalesce.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/coalesce.html b/site/docs/2.3.2/api/R/coalesce.html new file mode 100644 index 0000000..29642c0 --- /dev/null +++ b/site/docs/2.3.2/api/R/coalesce.html @@ -0,0 +1,131 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Coalesce</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for coalesce {SparkR}"><tr><td>coalesce {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Coalesce</h2> + +<h3>Description</h3> + +<p>Returns a new SparkDataFrame that has exactly <code>numPartitions</code> partitions. +This operation results in a narrow dependency, e.g. if you go from 1000 partitions to 100 +partitions, there will not be a shuffle, instead each of the 100 new partitions will claim 10 of +the current partitions. If a larger number of partitions is requested, it will stay at the +current number of partitions. +</p> + + +<h3>Usage</h3> + +<pre> +coalesce(x, ...) + +## S4 method for signature 'SparkDataFrame' +coalesce(x, numPartitions) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a SparkDataFrame.</p> +</td></tr> +<tr valign="top"><td><code>...</code></td> +<td> +<p>additional argument(s).</p> +</td></tr> +<tr valign="top"><td><code>numPartitions</code></td> +<td> +<p>the number of partitions to use.</p> +</td></tr> +</table> + + +<h3>Details</h3> + +<p>However, if you're doing a drastic coalesce on a SparkDataFrame, e.g. to numPartitions = 1, +this may result in your computation taking place on fewer nodes than +you like (e.g. one node in the case of numPartitions = 1). To avoid this, +call <code>repartition</code>. This will add a shuffle step, but means the +current upstream partitions will be executed in parallel (per whatever +the current partitioning is). +</p> + + +<h3>Note</h3> + +<p>coalesce(SparkDataFrame) since 2.1.1 +</p> + + +<h3>See Also</h3> + +<p><a href="repartition.html">repartition</a> +</p> +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="cache.html">cache</a></code>, +<code><a href="checkpoint.html">checkpoint</a></code>, <code><a href="collect.html">collect</a></code>, +<code><a href="columns.html">colnames</a></code>, <code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D path <- "path/to/file.json" +##D df <- read.json(path) +##D newDF <- coalesce(df, 1L) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/collect.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/collect.html b/site/docs/2.3.2/api/R/collect.html new file mode 100644 index 0000000..d191334 --- /dev/null +++ b/site/docs/2.3.2/api/R/collect.html @@ -0,0 +1,117 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Collects all the elements of a SparkDataFrame and coerces...</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for collect {SparkR}"><tr><td>collect {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Collects all the elements of a SparkDataFrame and coerces them into an R data.frame.</h2> + +<h3>Description</h3> + +<p>Collects all the elements of a SparkDataFrame and coerces them into an R data.frame. +</p> + + +<h3>Usage</h3> + +<pre> +collect(x, ...) + +## S4 method for signature 'SparkDataFrame' +collect(x, stringsAsFactors = FALSE) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>a SparkDataFrame.</p> +</td></tr> +<tr valign="top"><td><code>...</code></td> +<td> +<p>further arguments to be passed to or from other methods.</p> +</td></tr> +<tr valign="top"><td><code>stringsAsFactors</code></td> +<td> +<p>(Optional) a logical indicating whether or not string columns +should be converted to factors. FALSE by default.</p> +</td></tr> +</table> + + +<h3>Note</h3> + +<p>collect since 1.4.0 +</p> + + +<h3>See Also</h3> + +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="cache.html">cache</a></code>, +<code><a href="checkpoint.html">checkpoint</a></code>, <code><a href="coalesce.html">coalesce</a></code>, +<code><a href="columns.html">colnames</a></code>, <code><a href="coltypes.html">coltypes</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D sparkR.session() +##D path <- "path/to/file.json" +##D df <- read.json(path) +##D collected <- collect(df) +##D class(collected) +##D firstName <- names(collected)[1] +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/coltypes.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/coltypes.html b/site/docs/2.3.2/api/R/coltypes.html new file mode 100644 index 0000000..9bc9c07 --- /dev/null +++ b/site/docs/2.3.2/api/R/coltypes.html @@ -0,0 +1,132 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: coltypes</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for coltypes {SparkR}"><tr><td>coltypes {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>coltypes</h2> + +<h3>Description</h3> + +<p>Get column types of a SparkDataFrame +</p> +<p>Set the column types of a SparkDataFrame. +</p> + + +<h3>Usage</h3> + +<pre> +coltypes(x) + +coltypes(x) <- value + +## S4 method for signature 'SparkDataFrame' +coltypes(x) + +## S4 replacement method for signature 'SparkDataFrame,character' +coltypes(x) <- value +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>A SparkDataFrame</p> +</td></tr> +<tr valign="top"><td><code>value</code></td> +<td> +<p>A character vector with the target column types for the given +SparkDataFrame. Column types can be one of integer, numeric/double, character, logical, or NA +to keep that column as-is.</p> +</td></tr> +</table> + + +<h3>Value</h3> + +<p>value A character vector with the column types of the given SparkDataFrame +</p> + + +<h3>Note</h3> + +<p>coltypes since 1.6.0 +</p> +<p>coltypes<- since 1.6.0 +</p> + + +<h3>See Also</h3> + +<p>Other SparkDataFrame functions: <code><a href="SparkDataFrame.html">SparkDataFrame-class</a></code>, +<code><a href="summarize.html">agg</a></code>, <code><a href="alias.html">alias</a></code>, +<code><a href="arrange.html">arrange</a></code>, <code><a href="as.data.frame.html">as.data.frame</a></code>, +<code><a href="attach.html">attach,SparkDataFrame-method</a></code>, +<code><a href="broadcast.html">broadcast</a></code>, <code><a href="cache.html">cache</a></code>, +<code><a href="checkpoint.html">checkpoint</a></code>, <code><a href="coalesce.html">coalesce</a></code>, +<code><a href="collect.html">collect</a></code>, <code><a href="columns.html">colnames</a></code>, +<code><a href="createOrReplaceTempView.html">createOrReplaceTempView</a></code>, +<code><a href="crossJoin.html">crossJoin</a></code>, <code><a href="cube.html">cube</a></code>, +<code><a href="dapplyCollect.html">dapplyCollect</a></code>, <code><a href="dapply.html">dapply</a></code>, +<code><a href="describe.html">describe</a></code>, <code><a href="dim.html">dim</a></code>, +<code><a href="distinct.html">distinct</a></code>, <code><a href="dropDuplicates.html">dropDuplicates</a></code>, +<code><a href="nafunctions.html">dropna</a></code>, <code><a href="drop.html">drop</a></code>, +<code><a href="dtypes.html">dtypes</a></code>, <code><a href="except.html">except</a></code>, +<code><a href="explain.html">explain</a></code>, <code><a href="filter.html">filter</a></code>, +<code><a href="first.html">first</a></code>, <code><a href="gapplyCollect.html">gapplyCollect</a></code>, +<code><a href="gapply.html">gapply</a></code>, <code><a href="getNumPartitions.html">getNumPartitions</a></code>, +<code><a href="groupBy.html">group_by</a></code>, <code><a href="head.html">head</a></code>, +<code><a href="hint.html">hint</a></code>, <code><a href="histogram.html">histogram</a></code>, +<code><a href="insertInto.html">insertInto</a></code>, <code><a href="intersect.html">intersect</a></code>, +<code><a href="isLocal.html">isLocal</a></code>, <code><a href="isStreaming.html">isStreaming</a></code>, +<code><a href="join.html">join</a></code>, <code><a href="limit.html">limit</a></code>, +<code><a href="localCheckpoint.html">localCheckpoint</a></code>, <code><a href="merge.html">merge</a></code>, +<code><a href="mutate.html">mutate</a></code>, <code><a href="ncol.html">ncol</a></code>, +<code><a href="nrow.html">nrow</a></code>, <code><a href="persist.html">persist</a></code>, +<code><a href="printSchema.html">printSchema</a></code>, <code><a href="randomSplit.html">randomSplit</a></code>, +<code><a href="rbind.html">rbind</a></code>, <code><a href="registerTempTable-deprecated.html">registerTempTable</a></code>, +<code><a href="rename.html">rename</a></code>, <code><a href="repartition.html">repartition</a></code>, +<code><a href="rollup.html">rollup</a></code>, <code><a href="sample.html">sample</a></code>, +<code><a href="saveAsTable.html">saveAsTable</a></code>, <code><a href="schema.html">schema</a></code>, +<code><a href="selectExpr.html">selectExpr</a></code>, <code><a href="select.html">select</a></code>, +<code><a href="showDF.html">showDF</a></code>, <code><a href="show.html">show</a></code>, +<code><a href="storageLevel.html">storageLevel</a></code>, <code><a href="str.html">str</a></code>, +<code><a href="subset.html">subset</a></code>, <code><a href="summary.html">summary</a></code>, +<code><a href="take.html">take</a></code>, <code><a href="toJSON.html">toJSON</a></code>, +<code><a href="unionByName.html">unionByName</a></code>, <code><a href="union.html">union</a></code>, +<code><a href="unpersist.html">unpersist</a></code>, <code><a href="withColumn.html">withColumn</a></code>, +<code><a href="withWatermark.html">withWatermark</a></code>, <code><a href="with.html">with</a></code>, +<code><a href="write.df.html">write.df</a></code>, <code><a href="write.jdbc.html">write.jdbc</a></code>, +<code><a href="write.json.html">write.json</a></code>, <code><a href="write.orc.html">write.orc</a></code>, +<code><a href="write.parquet.html">write.parquet</a></code>, <code><a href="write.stream.html">write.stream</a></code>, +<code><a href="write.text.html">write.text</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D irisDF <- createDataFrame(iris) +##D coltypes(irisDF) # get column types +## End(Not run) +## Not run: +##D sparkR.session() +##D path <- "path/to/file.json" +##D df <- read.json(path) +##D coltypes(df) <- c("character", "integer") # set column types +##D coltypes(df) <- c(NA, "numeric") # set column types +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/column.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/column.html b/site/docs/2.3.2/api/R/column.html new file mode 100644 index 0000000..4c6de7a --- /dev/null +++ b/site/docs/2.3.2/api/R/column.html @@ -0,0 +1,77 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: S4 class that represents a SparkDataFrame column</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for column {SparkR}"><tr><td>column {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>S4 class that represents a SparkDataFrame column</h2> + +<h3>Description</h3> + +<p>The column class supports unary, binary operations on SparkDataFrame columns +</p> +<p>Returns a Column based on the given column name. +</p> + + +<h3>Usage</h3> + +<pre> +column(x) + +## S4 method for signature 'jobj' +column(x) + +## S4 method for signature 'character' +column(x) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>Character column name.</p> +</td></tr> +</table> + + +<h3>Slots</h3> + + +<dl> +<dt><code>jc</code></dt><dd><p>reference to JVM SparkDataFrame column</p> +</dd> +</dl> + + +<h3>Note</h3> + +<p>Column since 1.4.0 +</p> +<p>column since 1.6.0 +</p> + + +<h3>See Also</h3> + +<p>Other non-aggregate functions: <code><a href="column_nonaggregate_functions.html">column_nonaggregate_functions</a></code>, +<code><a href="not.html">not</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: column("name") +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/column_aggregate_functions.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/column_aggregate_functions.html b/site/docs/2.3.2/api/R/column_aggregate_functions.html new file mode 100644 index 0000000..01e3068 --- /dev/null +++ b/site/docs/2.3.2/api/R/column_aggregate_functions.html @@ -0,0 +1,348 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Aggregate functions for Column operations</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for column_aggregate_functions {SparkR}"><tr><td>column_aggregate_functions {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Aggregate functions for Column operations</h2> + +<h3>Description</h3> + +<p>Aggregate functions defined for <code>Column</code>. +</p> + + +<h3>Usage</h3> + +<pre> +approxCountDistinct(x, ...) + +collect_list(x) + +collect_set(x) + +countDistinct(x, ...) + +grouping_bit(x) + +grouping_id(x, ...) + +kurtosis(x) + +n_distinct(x, ...) + +sd(x, na.rm = FALSE) + +skewness(x) + +stddev(x) + +stddev_pop(x) + +stddev_samp(x) + +sumDistinct(x) + +var(x, y = NULL, na.rm = FALSE, use) + +variance(x) + +var_pop(x) + +var_samp(x) + +## S4 method for signature 'Column' +approxCountDistinct(x, rsd = 0.05) + +## S4 method for signature 'Column' +kurtosis(x) + +## S4 method for signature 'Column' +max(x) + +## S4 method for signature 'Column' +mean(x) + +## S4 method for signature 'Column' +min(x) + +## S4 method for signature 'Column' +sd(x) + +## S4 method for signature 'Column' +skewness(x) + +## S4 method for signature 'Column' +stddev(x) + +## S4 method for signature 'Column' +stddev_pop(x) + +## S4 method for signature 'Column' +stddev_samp(x) + +## S4 method for signature 'Column' +sum(x) + +## S4 method for signature 'Column' +sumDistinct(x) + +## S4 method for signature 'Column' +var(x) + +## S4 method for signature 'Column' +variance(x) + +## S4 method for signature 'Column' +var_pop(x) + +## S4 method for signature 'Column' +var_samp(x) + +## S4 method for signature 'Column' +approxCountDistinct(x, rsd = 0.05) + +## S4 method for signature 'Column' +countDistinct(x, ...) + +## S4 method for signature 'Column' +n_distinct(x, ...) + +## S4 method for signature 'Column' +collect_list(x) + +## S4 method for signature 'Column' +collect_set(x) + +## S4 method for signature 'Column' +grouping_bit(x) + +## S4 method for signature 'Column' +grouping_id(x, ...) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>Column to compute on.</p> +</td></tr> +<tr valign="top"><td><code>...</code></td> +<td> +<p>additional argument(s). For example, it could be used to pass additional Columns.</p> +</td></tr> +<tr valign="top"><td><code>y, na.rm, use</code></td> +<td> +<p>currently not used.</p> +</td></tr> +<tr valign="top"><td><code>rsd</code></td> +<td> +<p>maximum estimation error allowed (default = 0.05).</p> +</td></tr> +</table> + + +<h3>Details</h3> + +<p><code>approxCountDistinct</code>: Returns the approximate number of distinct items in a group. +</p> +<p><code>kurtosis</code>: Returns the kurtosis of the values in a group. +</p> +<p><code>max</code>: Returns the maximum value of the expression in a group. +</p> +<p><code>mean</code>: Returns the average of the values in a group. Alias for <code>avg</code>. +</p> +<p><code>min</code>: Returns the minimum value of the expression in a group. +</p> +<p><code>sd</code>: Alias for <code>stddev_samp</code>. +</p> +<p><code>skewness</code>: Returns the skewness of the values in a group. +</p> +<p><code>stddev</code>: Alias for <code>std_dev</code>. +</p> +<p><code>stddev_pop</code>: Returns the population standard deviation of the expression in a group. +</p> +<p><code>stddev_samp</code>: Returns the unbiased sample standard deviation of the expression in a group. +</p> +<p><code>sum</code>: Returns the sum of all values in the expression. +</p> +<p><code>sumDistinct</code>: Returns the sum of distinct values in the expression. +</p> +<p><code>var</code>: Alias for <code>var_samp</code>. +</p> +<p><code>var_pop</code>: Returns the population variance of the values in a group. +</p> +<p><code>var_samp</code>: Returns the unbiased variance of the values in a group. +</p> +<p><code>countDistinct</code>: Returns the number of distinct items in a group. +</p> +<p><code>n_distinct</code>: Returns the number of distinct items in a group. +</p> +<p><code>collect_list</code>: Creates a list of objects with duplicates. +</p> +<p><code>collect_set</code>: Creates a list of objects with duplicate elements eliminated. +</p> +<p><code>grouping_bit</code>: Indicates whether a specified column in a GROUP BY list is aggregated or +not, returns 1 for aggregated or 0 for not aggregated in the result set. Same as <code>GROUPING</code> +in SQL and <code>grouping</code> function in Scala. +</p> +<p><code>grouping_id</code>: Returns the level of grouping. +Equals to <code> +grouping_bit(c1) * 2^(n - 1) + grouping_bit(c2) * 2^(n - 2) + ... + grouping_bit(cn) +</code>. +</p> + + +<h3>Note</h3> + +<p>approxCountDistinct(Column) since 1.4.0 +</p> +<p>kurtosis since 1.6.0 +</p> +<p>max since 1.5.0 +</p> +<p>mean since 1.5.0 +</p> +<p>min since 1.5.0 +</p> +<p>sd since 1.6.0 +</p> +<p>skewness since 1.6.0 +</p> +<p>stddev since 1.6.0 +</p> +<p>stddev_pop since 1.6.0 +</p> +<p>stddev_samp since 1.6.0 +</p> +<p>sum since 1.5.0 +</p> +<p>sumDistinct since 1.4.0 +</p> +<p>var since 1.6.0 +</p> +<p>variance since 1.6.0 +</p> +<p>var_pop since 1.5.0 +</p> +<p>var_samp since 1.6.0 +</p> +<p>approxCountDistinct(Column, numeric) since 1.4.0 +</p> +<p>countDistinct since 1.4.0 +</p> +<p>n_distinct since 1.4.0 +</p> +<p>collect_list since 2.3.0 +</p> +<p>collect_set since 2.3.0 +</p> +<p>grouping_bit since 2.3.0 +</p> +<p>grouping_id since 2.3.0 +</p> + + +<h3>See Also</h3> + +<p>Other aggregate functions: <code><a href="avg.html">avg</a></code>, +<code><a href="corr.html">corr</a></code>, <code><a href="count.html">count</a></code>, +<code><a href="cov.html">cov</a></code>, <code><a href="first.html">first</a></code>, +<code><a href="last.html">last</a></code> +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D # Dataframe used throughout this doc +##D df <- createDataFrame(cbind(model = rownames(mtcars), mtcars)) +## End(Not run) + +## Not run: +##D head(select(df, approxCountDistinct(df$gear))) +##D head(select(df, approxCountDistinct(df$gear, 0.02))) +##D head(select(df, countDistinct(df$gear, df$cyl))) +##D head(select(df, n_distinct(df$gear))) +##D head(distinct(select(df, "gear"))) +## End(Not run) + +## Not run: +##D head(select(df, mean(df$mpg), sd(df$mpg), skewness(df$mpg), kurtosis(df$mpg))) +## End(Not run) + +## Not run: +##D head(select(df, avg(df$mpg), mean(df$mpg), sum(df$mpg), min(df$wt), max(df$qsec))) +##D +##D # metrics by num of cylinders +##D tmp <- agg(groupBy(df, "cyl"), avg(df$mpg), avg(df$hp), avg(df$wt), avg(df$qsec)) +##D head(orderBy(tmp, "cyl")) +##D +##D # car with the max mpg +##D mpg_max <- as.numeric(collect(agg(df, max(df$mpg)))) +##D head(where(df, df$mpg == mpg_max)) +## End(Not run) + +## Not run: +##D head(select(df, sd(df$mpg), stddev(df$mpg), stddev_pop(df$wt), stddev_samp(df$qsec))) +## End(Not run) + +## Not run: +##D head(select(df, sumDistinct(df$gear))) +##D head(distinct(select(df, "gear"))) +## End(Not run) + +## Not run: +##D head(agg(df, var(df$mpg), variance(df$mpg), var_pop(df$mpg), var_samp(df$mpg))) +## End(Not run) + +## Not run: +##D df2 = df[df$mpg > 20, ] +##D collect(select(df2, collect_list(df2$gear))) +##D collect(select(df2, collect_set(df2$gear))) +## End(Not run) + +## Not run: +##D # With cube +##D agg( +##D cube(df, "cyl", "gear", "am"), +##D mean(df$mpg), +##D grouping_bit(df$cyl), grouping_bit(df$gear), grouping_bit(df$am) +##D ) +##D +##D # With rollup +##D agg( +##D rollup(df, "cyl", "gear", "am"), +##D mean(df$mpg), +##D grouping_bit(df$cyl), grouping_bit(df$gear), grouping_bit(df$am) +##D ) +## End(Not run) + +## Not run: +##D # With cube +##D agg( +##D cube(df, "cyl", "gear", "am"), +##D mean(df$mpg), +##D grouping_id(df$cyl, df$gear, df$am) +##D ) +##D +##D # With rollup +##D agg( +##D rollup(df, "cyl", "gear", "am"), +##D mean(df$mpg), +##D grouping_id(df$cyl, df$gear, df$am) +##D ) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/04a27dbf/site/docs/2.3.2/api/R/column_collection_functions.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.2/api/R/column_collection_functions.html b/site/docs/2.3.2/api/R/column_collection_functions.html new file mode 100644 index 0000000..be7d4ca --- /dev/null +++ b/site/docs/2.3.2/api/R/column_collection_functions.html @@ -0,0 +1,249 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Collection functions for Column operations</title> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<link rel="stylesheet" type="text/css" href="R.css" /> + +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/styles/github.min.css"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/highlight.min.js"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.3/languages/r.min.js"></script> +<script>hljs.initHighlightingOnLoad();</script> +</head><body> + +<table width="100%" summary="page for column_collection_functions {SparkR}"><tr><td>column_collection_functions {SparkR}</td><td style="text-align: right;">R Documentation</td></tr></table> + +<h2>Collection functions for Column operations</h2> + +<h3>Description</h3> + +<p>Collection functions defined for <code>Column</code>. +</p> + + +<h3>Usage</h3> + +<pre> +array_contains(x, value) + +explode(x) + +explode_outer(x) + +from_json(x, schema, ...) + +map_keys(x) + +map_values(x) + +posexplode(x) + +posexplode_outer(x) + +size(x) + +sort_array(x, asc = TRUE) + +to_json(x, ...) + +## S4 method for signature 'Column' +to_json(x, ...) + +## S4 method for signature 'Column,characterOrstructType' +from_json(x, schema, + as.json.array = FALSE, ...) + +## S4 method for signature 'Column' +array_contains(x, value) + +## S4 method for signature 'Column' +map_keys(x) + +## S4 method for signature 'Column' +map_values(x) + +## S4 method for signature 'Column' +explode(x) + +## S4 method for signature 'Column' +size(x) + +## S4 method for signature 'Column' +sort_array(x, asc = TRUE) + +## S4 method for signature 'Column' +posexplode(x) + +## S4 method for signature 'Column' +explode_outer(x) + +## S4 method for signature 'Column' +posexplode_outer(x) +</pre> + + +<h3>Arguments</h3> + +<table summary="R argblock"> +<tr valign="top"><td><code>x</code></td> +<td> +<p>Column to compute on. Note the difference in the following methods: +</p> + +<ul> +<li> <p><code>to_json</code>: it is the column containing the struct, array of the structs, +the map or array of maps. +</p> +</li> +<li> <p><code>from_json</code>: it is the column containing the JSON string. +</p> +</li></ul> +</td></tr> +<tr valign="top"><td><code>value</code></td> +<td> +<p>a value to be checked if contained in the column</p> +</td></tr> +<tr valign="top"><td><code>schema</code></td> +<td> +<p>a structType object to use as the schema to use when parsing the JSON string. +Since Spark 2.3, the DDL-formatted string is also supported for the schema.</p> +</td></tr> +<tr valign="top"><td><code>...</code></td> +<td> +<p>additional argument(s). In <code>to_json</code> and <code>from_json</code>, this contains +additional named properties to control how it is converted, accepts the same +options as the JSON data source.</p> +</td></tr> +<tr valign="top"><td><code>asc</code></td> +<td> +<p>a logical flag indicating the sorting order. +TRUE, sorting is in ascending order. +FALSE, sorting is in descending order.</p> +</td></tr> +<tr valign="top"><td><code>as.json.array</code></td> +<td> +<p>indicating if input string is JSON array of objects or a single object.</p> +</td></tr> +</table> + + +<h3>Details</h3> + +<p><code>to_json</code>: Converts a column containing a <code>structType</code>, array of <code>structType</code>, +a <code>mapType</code> or array of <code>mapType</code> into a Column of JSON string. +Resolving the Column can fail if an unsupported type is encountered. +</p> +<p><code>from_json</code>: Parses a column containing a JSON string into a Column of <code>structType</code> +with the specified <code>schema</code> or array of <code>structType</code> if <code>as.json.array</code> is set +to <code>TRUE</code>. If the string is unparseable, the Column will contain the value NA. +</p> +<p><code>array_contains</code>: Returns null if the array is null, true if the array contains +the value, and false otherwise. +</p> +<p><code>map_keys</code>: Returns an unordered array containing the keys of the map. +</p> +<p><code>map_values</code>: Returns an unordered array containing the values of the map. +</p> +<p><code>explode</code>: Creates a new row for each element in the given array or map column. +</p> +<p><code>size</code>: Returns length of array or map. +</p> +<p><code>sort_array</code>: Sorts the input array in ascending or descending order according +to the natural ordering of the array elements. +</p> +<p><code>posexplode</code>: Creates a new row for each element with position in the given array +or map column. +</p> +<p><code>explode</code>: Creates a new row for each element in the given array or map column. +Unlike <code>explode</code>, if the array/map is <code>null</code> or empty +then <code>null</code> is produced. +</p> +<p><code>posexplode_outer</code>: Creates a new row for each element with position in the given +array or map column. Unlike <code>posexplode</code>, if the array/map is <code>null</code> or empty +then the row (<code>null</code>, <code>null</code>) is produced. +</p> + + +<h3>Note</h3> + +<p>to_json since 2.2.0 +</p> +<p>from_json since 2.2.0 +</p> +<p>array_contains since 1.6.0 +</p> +<p>map_keys since 2.3.0 +</p> +<p>map_values since 2.3.0 +</p> +<p>explode since 1.5.0 +</p> +<p>size since 1.5.0 +</p> +<p>sort_array since 1.6.0 +</p> +<p>posexplode since 2.1.0 +</p> +<p>explode_outer since 2.3.0 +</p> +<p>posexplode_outer since 2.3.0 +</p> + + +<h3>Examples</h3> + +<pre><code class="r">## Not run: +##D # Dataframe used throughout this doc +##D df <- createDataFrame(cbind(model = rownames(mtcars), mtcars)) +##D tmp <- mutate(df, v1 = create_array(df$mpg, df$cyl, df$hp)) +##D head(select(tmp, array_contains(tmp$v1, 21), size(tmp$v1))) +##D tmp2 <- mutate(tmp, v2 = explode(tmp$v1)) +##D head(tmp2) +##D head(select(tmp, posexplode(tmp$v1))) +##D head(select(tmp, sort_array(tmp$v1))) +##D head(select(tmp, sort_array(tmp$v1, asc = FALSE))) +##D tmp3 <- mutate(df, v3 = create_map(df$model, df$cyl)) +##D head(select(tmp3, map_keys(tmp3$v3))) +##D head(select(tmp3, map_values(tmp3$v3))) +## End(Not run) + +## Not run: +##D # Converts a struct into a JSON object +##D df2 <- sql("SELECT named_struct('date', cast('2000-01-01' as date)) as d") +##D select(df2, to_json(df2$d, dateFormat = 'dd/MM/yyyy')) +##D +##D # Converts an array of structs into a JSON array +##D df2 <- sql("SELECT array(named_struct('name', 'Bob'), named_struct('name', 'Alice')) as people") +##D df2 <- mutate(df2, people_json = to_json(df2$people)) +##D +##D # Converts a map into a JSON object +##D df2 <- sql("SELECT map('name', 'Bob')) as people") +##D df2 <- mutate(df2, people_json = to_json(df2$people)) +##D +##D # Converts an array of maps into a JSON array +##D df2 <- sql("SELECT array(map('name', 'Bob'), map('name', 'Alice')) as people") +##D df2 <- mutate(df2, people_json = to_json(df2$people)) +## End(Not run) + +## Not run: +##D df2 <- sql("SELECT named_struct('date', cast('2000-01-01' as date)) as d") +##D df2 <- mutate(df2, d2 = to_json(df2$d, dateFormat = 'dd/MM/yyyy')) +##D schema <- structType(structField("date", "string")) +##D head(select(df2, from_json(df2$d2, schema, dateFormat = 'dd/MM/yyyy'))) +##D df2 <- sql("SELECT named_struct('name', 'Bob') as people") +##D df2 <- mutate(df2, people_json = to_json(df2$people)) +##D schema <- structType(structField("name", "string")) +##D head(select(df2, from_json(df2$people_json, schema))) +##D head(select(df2, from_json(df2$people_json, "name STRING"))) +## End(Not run) + +## Not run: +##D df2 <- createDataFrame(data.frame( +##D id = c(1, 2, 3), text = c("a,b,c", NA, "d,e") +##D )) +##D +##D head(select(df2, df2$id, explode_outer(split_string(df2$text, ",")))) +##D head(select(df2, df2$id, posexplode_outer(split_string(df2$text, ",")))) +## End(Not run) +</code></pre> + + +<hr /><div style="text-align: center;">[Package <em>SparkR</em> version 2.3.2 <a href="00Index.html">Index</a>]</div> +</body></html> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org