document list service rastyer fns

R-ArcGIS · Oct 4, 2024 · 3ea9642 · 3ea9642
1 parent e453efa
commit 3ea9642
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+CRAN-SUBMISSION
 .httr-oauth
 .Rprofile
 .Rprofile

diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION
diff --git a/NAMESPACE b/NAMESPACE
@@ -31,6 +31,7 @@ export(get_layer_estimates)
 export(get_layers)
 export(list_fields)
 export(list_items)
+export(list_service_raster_fns)
 export(match_spatial_rel)
 export(prepare_spatial_filter)
 export(publish_item)

diff --git a/R/raster-fns.R b/R/raster-fns.R
@@ -6,9 +6,17 @@
 #' @inheritParams arcgisutils::infer_esri_type
 #' @param x an `ImageServer`.
 #' @returns a data.frame of the available raster functions.
+#' @export
 #' @examples
-#' # example code
-#'
+#' # use paste to avoid cran note
+#' furl <- paste0(
+#'   "https://di-usfsdata.img.arcgis.com/arcgis/rest/services",
+#'   "/FIA_BIGMAP_2018_Species_Aboveground_Biomass/ImageServer"
+#' )
+#' 
+#' service <- arc_open(furl)
+#' raster_fns <- list_service_raster_fns(service)
+#' head(raster_fns)
 list_service_raster_fns <- function(x, arg = rlang::caller_arg(x), call = rlang::caller_call()) {
   check_inherits_any(x, "ImageServer")
 

diff --git a/man/list_service_raster_fns.Rd b/man/list_service_raster_fns.Rd