From 7ee22de364d4f518b9f7d74a1acacfe3aa2c736d Mon Sep 17 00:00:00 2001 From: Jia Yu Date: Thu, 12 Oct 2023 02:06:24 -0700 Subject: [PATCH] [DOCS] R: Update roxygen docs (#1049) --- R/man/apache.sedona-package.Rd | 5 +++-- R/man/crs_transform.Rd | 2 +- R/man/spark_read_shapefile.Rd | 14 +------------- R/man/spark_write_geojson.Rd | 13 +------------ 4 files changed, 6 insertions(+), 28 deletions(-) diff --git a/R/man/apache.sedona-package.Rd b/R/man/apache.sedona-package.Rd index 52f4c6c030..71d0262aee 100644 --- a/R/man/apache.sedona-package.Rd +++ b/R/man/apache.sedona-package.Rd @@ -6,9 +6,10 @@ \alias{apache.sedona-package} \title{apache.sedona: R Interface for Apache Sedona} \description{ -\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} +\if{html}{\figure{logo.png}{options: align='right' alt='logo' width='120'}} -R interface for 'Apache Sedona' based on 'sparklyr' (\url{https://sedona.apache.org}). +R interface for 'Apache Sedona' based on 'sparklyr' + (). } \seealso{ Useful links: diff --git a/R/man/crs_transform.Rd b/R/man/crs_transform.Rd index 3aa13cc9d6..22624e2cd3 100644 --- a/R/man/crs_transform.Rd +++ b/R/man/crs_transform.Rd @@ -23,7 +23,7 @@ The transformed SpatialRDD. } \description{ Transform data within a spatial RDD from one coordinate reference system to -another. +another. This uses the lon/lat order since v1.5.0. Before, it used lat/lon } \examples{ library(sparklyr) diff --git a/R/man/spark_read_shapefile.Rd b/R/man/spark_read_shapefile.Rd index 61c1895e55..dcb59ca472 100644 --- a/R/man/spark_read_shapefile.Rd +++ b/R/man/spark_read_shapefile.Rd @@ -4,7 +4,6 @@ \alias{spark_read_shapefile} \alias{spark_read_geojson} \alias{spark_read_geoparquet} -\alias{spark_read_geotiff} \title{Read geospatial data into a Spark DataFrame.} \usage{ spark_read_shapefile(sc, name = NULL, path = name, options = list(), ...) @@ -28,16 +27,6 @@ spark_read_geoparquet( memory = TRUE, overwrite = TRUE ) - -spark_read_geotiff( - sc, - name = NULL, - path = name, - options = list(), - repartition = 0, - memory = TRUE, - overwrite = TRUE -) } \arguments{ \item{sc}{A \code{spark_connection}.} @@ -47,7 +36,7 @@ spark_read_geotiff( \item{path}{The path to the file. Needs to be accessible from the cluster. Supports the \samp{"hdfs://"}, \samp{"s3a://"} and \samp{"file://"} protocols.} -\item{options}{A list of strings with additional options. See \url{https://spark.apache.org/docs/latest/sql-programming-guide.html#configuration}.} +\item{options}{A list of strings with additional options. See \url{http://spark.apache.org/docs/latest/sql-programming-guide.html#configuration}.} \item{...}{Optional arguments; currently unused.} @@ -69,7 +58,6 @@ Functions to read geospatial data from a variety of formats into Spark DataFrame \item \code{spark_read_shapefile}: from a shapefile \item \code{spark_read_geojson}: from a geojson file \item \code{spark_read_geoparquet}: from a geoparquet file -\item \code{spark_read_geotiff}: from a GeoTiff file, or a folder containing GeoTiff files } } \examples{ diff --git a/R/man/spark_write_geojson.Rd b/R/man/spark_write_geojson.Rd index aff5116fea..746dcccc60 100644 --- a/R/man/spark_write_geojson.Rd +++ b/R/man/spark_write_geojson.Rd @@ -3,7 +3,6 @@ \name{spark_write_geojson} \alias{spark_write_geojson} \alias{spark_write_geoparquet} -\alias{spark_write_geotiff} \alias{spark_write_raster} \title{Write geospatial data from a Spark DataFrame.} \usage{ @@ -25,15 +24,6 @@ spark_write_geoparquet( ... ) -spark_write_geotiff( - x, - path, - mode = NULL, - options = list(), - partition_by = NULL, - ... -) - spark_write_raster( x, path, @@ -53,7 +43,7 @@ Supports the \samp{"hdfs://"}, \samp{"s3a://"} and \samp{"file://"} protocols.} table already exists. Supported values include: 'error', 'append', 'overwrite' and ignore. Notice that 'overwrite' will also change the column structure. - For more details see also \url{https://spark.apache.org/docs/latest/sql-programming-guide.html#save-modes} + For more details see also \url{http://spark.apache.org/docs/latest/sql-programming-guide.html#save-modes} for your version of Spark.} \item{options}{A list of strings with additional options.} @@ -67,7 +57,6 @@ Functions to write geospatial data into a variety of formats from Spark DataFram \itemize{ \item \code{spark_write_geojson}: to GeoJSON \item \code{spark_write_geoparquet}: to GeoParquet -\item \code{spark_write_geotiff}: to GeoTiff from Array[Double] rasters \item \code{spark_write_raster}: to raster tiles after using RS output functions (\code{RS_AsXXX}) } }