From 0e5e2af246296de5d974b1f250c9007db620c7e9 Mon Sep 17 00:00:00 2001 From: Adam Sparks Date: Mon, 18 Apr 2022 15:04:22 +0800 Subject: [PATCH] redoc package --- man/as.geojson.Rd | 16 ++++++++-------- man/get_chirps.Rd | 16 ++++++++-------- man/get_esi.Rd | 6 +++--- man/get_imerg.Rd | 2 +- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/man/as.geojson.Rd b/man/as.geojson.Rd index 23f1dd1..d7d4555 100644 --- a/man/as.geojson.Rd +++ b/man/as.geojson.Rd @@ -6,16 +6,16 @@ \alias{as.geojson.sf} \title{Methods to coerce geographical coordinates into a geojson polygon} \usage{ -as.geojson(lonlat, dist = 1e-05, nQuadSegs = 2L, ...) +as.geojson(lonlat, dist = 0.00001, nQuadSegs = 2L, ...) -\method{as.geojson}{default}(lonlat, dist = 1e-05, nQuadSegs = 2L, ...) +\method{as.geojson}{default}(lonlat, dist = 0.00001, nQuadSegs = 2L, ...) -\method{as.geojson}{sf}(lonlat, dist = 1e-05, nQuadSegs = 2L, ...) +\method{as.geojson}{sf}(lonlat, dist = 0.00001, nQuadSegs = 2L, ...) } \arguments{ -\item{lonlat}{a data.frame or matrix with geographical coordinates lonlat, in -that order, or an object of class 'sf' with geometry type 'POINT' or -'POLYGON'} +\item{lonlat}{a \code{data.frame} or matrix with geographical coordinates +'lonlat', in that order, or an object of class \code{\link[sf]{sf}} with +geometry type 'POINT' or 'POLYGON'} \item{dist}{numeric, buffer distance for all \code{lonlat}} @@ -27,8 +27,8 @@ that order, or an object of class 'sf' with geometry type 'POINT' or An object of class 'geosjon' for each row in \code{lonlat} } \description{ -Take single points from geographical coordinates and coerce into a -geojson of geometry 'Polygon' +Take single points from geographical coordinates and coerce into a geojson of + geometry 'Polygon' } \examples{ \dontshow{if (interactive()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/get_chirps.Rd b/man/get_chirps.Rd index a16e678..9440e3a 100644 --- a/man/get_chirps.Rd +++ b/man/get_chirps.Rd @@ -40,10 +40,10 @@ any other object that can be coerced to \code{data.frame}), \item{dates}{a character of start and end dates in that order in the format "YYYY-MM-DD"} -\item{server}{a character that represent the server source "CHC" or +\item{server}{a character that represents the server source "CHC" or "ClimateSERV"} -\item{...}{additional arguments passed to \code{\link[terra]{terra}} +\item{...}{additional arguments passed to \code{\link[terra]{terra}} or \code{\link[sf]{sf}} methods See details} @@ -67,13 +67,13 @@ A matrix, raster or a data frame of \acronym{CHIRPS} data: } } \description{ -Get daily precipitation data from the "Climate Hazards Group". Two server - sources are available. The first, "CHC" (default) is recommended for - multiple data-points, while "ClimateSERV" is recommended when - few data-points are required (~ 50). +Get daily precipitation data from the "Climate Hazards Group". Two server + sources are available. The first, "CHC" (default) is recommended for + multiple data-points, while "ClimateSERV" is recommended when few + data-points are required (~ 50). } \details{ -Data description at +Data description at \url{https://data.chc.ucsb.edu/products/CHIRPS-2.0/README-CHIRPS.txt} \strong{Additional arguments when using server = "CHC"} @@ -98,7 +98,7 @@ Data description at } } \note{ -\code{get_chirps()} may return some warning messages given by +\code{get_chirps()} may return some warning messages given by \code{\link[sf]{sf}}, please look \CRANpkg{sf} documentation for possible issues. } diff --git a/man/get_esi.Rd b/man/get_esi.Rd index 34a177b..112a33c 100644 --- a/man/get_esi.Rd +++ b/man/get_esi.Rd @@ -30,7 +30,7 @@ statistical operation to perform on the dataset} \item{period}{an integer value for the period of ESI data, four weeks period = 1, twelve weeks = 2} -\item{...}{additional arguments passed to \code{\link[terra]{terra}} +\item{...}{additional arguments passed to \code{\link[terra]{terra}} or \code{\link[sf]{sf}} methods See details} @@ -70,8 +70,8 @@ ClimateSERV works with 'geojson' of type 'Polygon'. The input \code{object} \bold{nQuadSegs}: integer, number of segments per buffer quadrant } \note{ -\code{get_esi()} may return some warning messages given by -\code{\link[sf]{sf}}, please check the \CRANpkg{sf} documentation for +\code{get_esi()} may return some warning messages given by +\code{\link[sf]{sf}}, please check the \CRANpkg{sf} documentation for possible issues. } \examples{ diff --git a/man/get_imerg.Rd b/man/get_imerg.Rd index 70368f2..6a5fa91 100644 --- a/man/get_imerg.Rd +++ b/man/get_imerg.Rd @@ -27,7 +27,7 @@ any other object that can be coerced to \code{data.frame}), \item{operation}{optional, an integer that represents which type of statistical operation to perform on the dataset} -\item{...}{additional arguments passed to \code{\link[terra]{terra}} +\item{...}{additional arguments passed to \code{\link[terra]{terra}} or \code{\link[sf]{sf}} methods See details}