From 7a67e2db3caeccf42c693067076ce224cbaf2de1 Mon Sep 17 00:00:00 2001 From: Robin Lovelace Date: Mon, 30 Aug 2021 22:03:58 +0100 Subject: [PATCH] Update elevation_get() docs for #32 --- R/slope_get.R | 8 ++++++-- man/elevation_get.Rd | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/R/slope_get.R b/R/slope_get.R index 1fb4d70..42105f9 100644 --- a/R/slope_get.R +++ b/R/slope_get.R @@ -1,9 +1,13 @@ #' Get elevation data from hosted maptile services #' -#' `elevation_get()` uses the `[ceramic::cc_elevation()]` function to get +#' `elevation_get()` uses the +#' [`cc_elevation()`](https://hypertidy.github.io/ceramic/reference/cc_location.html) +#' function from the `ceramic` package to get #' DEM data in raster format anywhere worldwide. #' It requires an API that can be added by following guidance in the package's -#' [README](https://github.com/ITSLeeds/slopes#installation-for-dem-downloads). +#' [README](https://github.com/ITSLeeds/slopes#installation-for-dem-downloads) +#' and in the +#' [`slopes` vignette](https://itsleeds.github.io/slopes/articles/slopes.html). #' #' #' Note: if you use the `cc_elevation()` function directly to get DEM data, diff --git a/man/elevation_get.Rd b/man/elevation_get.Rd index af9b495..0468de1 100644 --- a/man/elevation_get.Rd +++ b/man/elevation_get.Rd @@ -17,10 +17,14 @@ A raster object with cell values representing elevations in the bounding box of the input \code{routes} object. } \description{ -\code{elevation_get()} uses the \verb{[ceramic::cc_elevation()]} function to get +\code{elevation_get()} uses the +\href{https://hypertidy.github.io/ceramic/reference/cc_location.html}{\code{cc_elevation()}} +function from the \code{ceramic} package to get DEM data in raster format anywhere worldwide. It requires an API that can be added by following guidance in the package's -\href{https://github.com/ITSLeeds/slopes#installation-for-dem-downloads}{README}. +\href{https://github.com/ITSLeeds/slopes#installation-for-dem-downloads}{README} +and in the +\href{https://itsleeds.github.io/slopes/articles/slopes.html}{\code{slopes} vignette}. } \details{ Note: if you use the \code{cc_elevation()} function directly to get DEM data,