Merge pull request apache#136 from shivaram/man-updates

Add missing man pages

Author: concretevitamin

pkg/man/checkpoint-methods.Rd

@@ -0,0 +1,30 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{methods}
+\name{checkpoint}
+\alias{checkpoint}
+\alias{checkpoint,RDD-method}
+\title{Checkpoint an RDD}
+\usage{
+checkpoint(rdd)
+
+\S4method{checkpoint}{RDD}(rdd)
+}
+\arguments{
+\item{rdd}{The RDD to checkpoint}
+}
+\description{
+Mark this RDD for checkpointing. It will be saved to a file inside the
+checkpoint directory set with setCheckpointDir() and all references to its
+parent RDDs will be removed. This function must be called before any job has
+been executed on this RDD. It is strongly recommended that this RDD is
+persisted in memory, otherwise saving it on a file will require recomputation.
+}
+\examples{
+\dontrun{
+sc <- sparkR.init()
+setCheckpointDir(sc, "checkpoints")
+rdd <- parallelize(sc, 1:10, 2L)
+checkpoint(rdd)
+}
+}
+

pkg/man/saveAsTextFile.Rd

@@ -0,0 +1,28 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{methods}
+\name{saveAsTextFile}
+\alias{saveAsTextFile}
+\alias{saveAsTextFile,RDD}
+\alias{saveAsTextFile,RDD,character-method}
+\title{Save this RDD as a text file, using string representations of elements.}
+\usage{
+saveAsTextFile(rdd, path)
+
+\S4method{saveAsTextFile}{RDD,character}(rdd, path)
+}
+\arguments{
+\item{rdd}{The RDD to save}
+
+\item{path}{The directory where the splits of the text file are saved}
+}
+\description{
+Save this RDD as a text file, using string representations of elements.
+}
+\examples{
+\dontrun{
+sc <- sparkR.init()
+rdd <- parallelize(sc, 1:3)
+saveAsTextFile(rdd, "/tmp/sparkR-tmp")
+}
+}
+

pkg/man/setCheckpointDir.Rd

@@ -0,0 +1,30 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\name{setCheckpointDir}
+\alias{setCheckpointDir}
+\title{Set the checkpoint directory
+
+Set the directory under which RDDs are going to be checkpointed. The
+directory must be a HDFS path if running on a cluster.}
+\usage{
+setCheckpointDir(sc, dirName)
+}
+\arguments{
+\item{sc}{Spark Context to use}
+
+\item{dirName}{Directory path}
+}
+\description{
+Set the checkpoint directory
+
+Set the directory under which RDDs are going to be checkpointed. The
+directory must be a HDFS path if running on a cluster.
+}
+\examples{
+\dontrun{
+sc <- sparkR.init()
+setCheckpointDir(sc, "~/checkpoints")
+rdd <- parallelize(sc, 1:2, 2L)
+checkpoint(rdd)
+}
+}
+

pkg/man/unpersist-methods.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
+\docType{methods}
+\name{unpersist}
+\alias{unpersist}
+\alias{unpersist,RDD-method}
+\title{Unpersist an RDD}
+\usage{
+unpersist(rdd)
+
+\S4method{unpersist}{RDD}(rdd)
+}
+\arguments{
+\item{rdd}{The RDD to unpersist}
+}
+\description{
+Mark the RDD as non-persistent, and remove all blocks for it from memory and
+disk.
+}
+\examples{
+\dontrun{
+sc <- sparkR.init()
+rdd <- parallelize(sc, 1:10, 2L)
+cache(rdd) # rdd@env$isCached == TRUE
+unpersist(rdd) # rdd@env$isCached == FALSE
+}
+}
+