From 9370cab43fecb6722202679031ca08c9a792b38d Mon Sep 17 00:00:00 2001 From: runner Date: Tue, 23 Jan 2024 21:05:20 +0000 Subject: [PATCH] GitHub Actions Update documentation --- DESCRIPTION | 2 +- man/get_geo_mosaic_name.Rd | 26 ++++++++++++++++++++++++++ man/get_geo_mosaics.Rd | 19 +++++++++++-------- man/get_geo_polygon_name.Rd | 26 ++++++++++++++++++++++++++ man/get_geo_polygons.Rd | 29 +++++++++++++++++++++++++++++ man/get_geo_stores.Rd | 26 -------------------------- 6 files changed, 93 insertions(+), 35 deletions(-) create mode 100644 man/get_geo_mosaic_name.Rd create mode 100644 man/get_geo_polygon_name.Rd create mode 100644 man/get_geo_polygons.Rd delete mode 100644 man/get_geo_stores.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 56e8fe3..dd26f2c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: aclimaterapi Type: Package Title: AClimate R API Package -Version: 0.1.3 +Version: 0.1.4 Date: 2023-11-15 Authors@R: person("Steven", "Sotelo", email = "stevenbetancurt@hotmail.com",role = c("aut", "cre")) Description: The AClimate R API package is a comprehensive R interface for accessing the AClimate Web API. diff --git a/man/get_geo_mosaic_name.Rd b/man/get_geo_mosaic_name.Rd new file mode 100644 index 0000000..2e0e817 --- /dev/null +++ b/man/get_geo_mosaic_name.Rd @@ -0,0 +1,26 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/geoserver.R +\name{get_geo_mosaic_name} +\alias{get_geo_mosaic_name} +\title{Get geoserver mosaic stores} +\usage{ +get_geo_mosaic_name(url_root, workspace) +} +\arguments{ +\item{url_root}{Url root where the Geoserver is located.} + +\item{workspace}{Name of the workspace from which the mosaic datastores are to be obtained.} +} +\value{ +A dataframe with mosaics stores information. +} +\description{ +Retrieves and lists all the mosaic stores of a specific workspace using the HTTP GET method. +} +\examples{ +url_root = "https://geo.aclimate.org/geoserver/" +workspace = "climate_indices_pe" +obj_f = get_geo_mosaic_name(url_root, workspace) +print(obj_f) + +} diff --git a/man/get_geo_mosaics.Rd b/man/get_geo_mosaics.Rd index fb374b1..3241e99 100644 --- a/man/get_geo_mosaics.Rd +++ b/man/get_geo_mosaics.Rd @@ -2,20 +2,22 @@ % Please edit documentation in R/geoserver.R \name{get_geo_mosaics} \alias{get_geo_mosaics} -\title{Get geoserver get_geo_mosaics} +\title{Get geoserver mosaics} \usage{ -get_geo_mosaics(url_root, workspace, store_name, year, month) +get_geo_mosaics(url_root, workspace, mosaic_name, year, month = 1, day = 1) } \arguments{ \item{url_root}{Url root where the Geoserver is located.} -\item{workspace}{Name of the workspace from which the datastores are to be obtained.} +\item{workspace}{Name of the workspace from which the mosaics datastores are to be obtained.} -\item{store_name}{Name of the store from which the mosaics are to be obtained.} +\item{mosaic_name}{Name of the store from which the mosaics are to be obtained.} -\item{year}{Year by which the mosaic will be filtered.} +\item{year}{Year by which the mosaic will be filtered. Integer} -\item{month}{Month by which the mosaic will be filtered.} +\item{month}{Month by which the mosaic will be filtered. Integer (Optional, default value 1)} + +\item{day}{Day by which the mosaic will be filtered. Integer (Optional, default value 1)} } \value{ A raster with mosaic information or Null if an error is encountered, it will also be printed to the console. @@ -26,10 +28,11 @@ Obtains the desired mosaic from the GeoServer using the HTTP GET method, by usin \examples{ url_root = "https://geo.aclimate.org/geoserver/" workspace = "climate_indices_pe" -store_name = "freq_rh80_t_20_25" +mosaic_name = "freq_rh80_t_20_25" year = 2014 month = 5 -obj_f = get_geo_mosaics(url_root, workspace, store_name, year, month) +day = 1 +obj_f = get_geo_mosaics(url_root, workspace, mosaic_name, year, month, day) print(obj_f) } diff --git a/man/get_geo_polygon_name.Rd b/man/get_geo_polygon_name.Rd new file mode 100644 index 0000000..9e57798 --- /dev/null +++ b/man/get_geo_polygon_name.Rd @@ -0,0 +1,26 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/geoserver.R +\name{get_geo_polygon_name} +\alias{get_geo_polygon_name} +\title{Get geoserver polygon stores} +\usage{ +get_geo_polygon_name(url_root, workspace) +} +\arguments{ +\item{url_root}{Url root where the Geoserver is located.} + +\item{workspace}{Name of the workspace from which the polygon datastores are to be obtained.} +} +\value{ +A dataframe with polygons stores information. +} +\description{ +Retrieves and lists all the polygon stores of a specific workspace using the HTTP GET method. +} +\examples{ +url_root = "https://geo.aclimate.org/geoserver/" +workspace = "administrative" +obj_f = get_geo_polygon_name(url_root, workspace) +print(obj_f) + +} diff --git a/man/get_geo_polygons.Rd b/man/get_geo_polygons.Rd new file mode 100644 index 0000000..87c4531 --- /dev/null +++ b/man/get_geo_polygons.Rd @@ -0,0 +1,29 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/geoserver.R +\name{get_geo_polygons} +\alias{get_geo_polygons} +\title{Get geoserver shapefiles} +\usage{ +get_geo_polygons(url_root, workspace, polygon_name) +} +\arguments{ +\item{url_root}{Url root where the Geoserver is located.} + +\item{workspace}{Name of the workspace from which the shapefiles are to be obtained.} + +\item{polygon_name}{Name of the store from which the shapefiles are to be obtained.} +} +\value{ +A shapefile with the polygon information or Null if an error is encountered, it will also be printed to the console. +} +\description{ +Obtains the desired shapefile from the GeoServer using the HTTP GET method, by using workspace, and polygon name +} +\examples{ +url_root = "https://geo.aclimate.org/geoserver/" +workspace = "administrative" +polygon_name = "ao_adm1" +obj_f = get_geo_polygons(url_root, workspace, polygon_name) +print(obj_f) + +} diff --git a/man/get_geo_stores.Rd b/man/get_geo_stores.Rd deleted file mode 100644 index 82daec5..0000000 --- a/man/get_geo_stores.Rd +++ /dev/null @@ -1,26 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/geoserver.R -\name{get_geo_stores} -\alias{get_geo_stores} -\title{Get geoserver stores} -\usage{ -get_geo_stores(url_root, workspace) -} -\arguments{ -\item{url_root}{Url root where the Geoserver is located.} - -\item{workspace}{Name of the workspace from which the datastores are to be obtained.} -} -\value{ -A dataframe with stores information. -} -\description{ -Retrieves and lists all the stores of a specific workspace using the HTTP GET method. -} -\examples{ -url_root = "https://geo.aclimate.org/geoserver/" -workspace = "climate_indices_pe" -obj_f = get_geo_stores(url_root, workspace) -print(obj_f) - -}