Skip to content

Commit 9c2a062

Browse files
author
Davies Liu
committed
mention R api together with Python API
1 parent 23f751a commit 9c2a062

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

docs/api.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ Here you can API docs for Spark and its submodules.
77

88
- [Spark Scala API (Scaladoc)](api/scala/index.html)
99
- [Spark Java API (Javadoc)](api/java/index.html)
10-
- [Spark Python API (Epydoc)](api/python/index.html)
10+
- [Spark Python API (Sphinx)](api/python/index.html)
11+
- [Spark R API (Roxygen2)](api/R/index.html)

docs/index.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Apache Spark SPARK_VERSION_SHORT documentation homepage
66
---
77

88
Apache Spark is a fast and general-purpose cluster computing system.
9-
It provides high-level APIs in Java, Scala and Python,
9+
It provides high-level APIs in Java, Scala, Python and R,
1010
and an optimized engine that supports general execution graphs.
1111
It also supports a rich set of higher-level tools including [Spark SQL](sql-programming-guide.html) for SQL and structured data processing, [MLlib](mllib-guide.html) for machine learning, [GraphX](graphx-programming-guide.html) for graph processing, and [Spark Streaming](streaming-programming-guide.html).
1212

@@ -20,13 +20,13 @@ Spark runs on both Windows and UNIX-like systems (e.g. Linux, Mac OS). It's easy
2020
locally on one machine --- all you need is to have `java` installed on your system `PATH`,
2121
or the `JAVA_HOME` environment variable pointing to a Java installation.
2222

23-
Spark runs on Java 6+ and Python 2.6+. For the Scala API, Spark {{site.SPARK_VERSION}} uses
23+
Spark runs on Java 6+, Python 2.6+ and R 3.1+. For the Scala API, Spark {{site.SPARK_VERSION}} uses
2424
Scala {{site.SCALA_BINARY_VERSION}}. You will need to use a compatible Scala version
2525
({{site.SCALA_BINARY_VERSION}}.x).
2626

2727
# Running the Examples and Shell
2828

29-
Spark comes with several sample programs. Scala, Java and Python examples are in the
29+
Spark comes with several sample programs. Scala, Java, Python and R examples are in the
3030
`examples/src/main` directory. To run one of the Java or Scala sample programs, use
3131
`bin/run-example <class> [params]` in the top-level Spark directory. (Behind the scenes, this
3232
invokes the more general
@@ -54,6 +54,15 @@ Example applications are also provided in Python. For example,
5454

5555
./bin/spark-submit examples/src/main/python/pi.py 10
5656

57+
Spark also provides a R API. To run Spark interactively in a R interpreter, use
58+
`bin/sparkR`:
59+
60+
./bin/sparkR --master local[2]
61+
62+
Example applications are also provided in R. For example,
63+
64+
./bin/spark-submit examples/src/main/r/pi.R 10
65+
5766
# Launching on a Cluster
5867

5968
The Spark [cluster mode overview](cluster-overview.html) explains the key concepts in running on a cluster.
@@ -71,7 +80,7 @@ options for deployment:
7180

7281
* [Quick Start](quick-start.html): a quick introduction to the Spark API; start here!
7382
* [Spark Programming Guide](programming-guide.html): detailed overview of Spark
74-
in all supported languages (Scala, Java, Python)
83+
in all supported languages (Scala, Java, Python, R)
7584
* Modules built on Spark:
7685
* [Spark Streaming](streaming-programming-guide.html): processing real-time data streams
7786
* [Spark SQL and DataFrames](sql-programming-guide.html): support for structured data and relational queries
@@ -125,4 +134,5 @@ options for deployment:
125134
available online for free.
126135
* [Code Examples](http://spark.apache.org/examples.html): more are also available in the `examples` subfolder of Spark ([Scala]({{site.SPARK_GITHUB_URL}}/tree/master/examples/src/main/scala/org/apache/spark/examples),
127136
[Java]({{site.SPARK_GITHUB_URL}}/tree/master/examples/src/main/java/org/apache/spark/examples),
128-
[Python]({{site.SPARK_GITHUB_URL}}/tree/master/examples/src/main/python))
137+
[Python]({{site.SPARK_GITHUB_URL}}/tree/master/examples/src/main/python),
138+
[R]({{site.SPARK_GITHUB_URL}}/tree/master/examples/src/main/r))

0 commit comments

Comments
 (0)