diff --git a/DESCRIPTION b/DESCRIPTION index 727fc58..01bb8b4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -77,5 +77,6 @@ Collate: 'rasterizeLine.R' 'prepExData.R' 'roads-package.R' + 'dem_example.R' BugReports: https://github.com/LandSciTech/roads/issues Roxygen: list(markdown = TRUE) diff --git a/R/dem_example.R b/R/dem_example.R index 22681e7..11e790b 100644 --- a/R/dem_example.R +++ b/R/dem_example.R @@ -46,6 +46,6 @@ #' * ex_wat: a `PackedSpatRaster` of proportion water. #' #' @examples -#' CLUSexample -#' prepExData(CLUSexample) -"CLUSexample" \ No newline at end of file +#' dem_example +#' prepExData(dem_example) +"dem_example" \ No newline at end of file diff --git a/man/CLUSexample.Rd b/man/CLUSexample.Rd index d9c49c2..a380f79 100644 --- a/man/CLUSexample.Rd +++ b/man/CLUSexample.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/CLUSexample.R, R/dem_example.R +% Please edit documentation in R/CLUSexample.R \docType{data} \name{CLUSexample} \alias{CLUSexample} @@ -11,50 +11,17 @@ A named list with components: \item landings: an sf dataframe of points representing landing locations. \item roads: a \code{PackedSpatRaster} representing existing roads. } - -A named list with components: -\itemize{ -\item ex_elev: a \code{PackedSpatRaster} of elevation. -\item ex_wat: a \code{PackedSpatRaster} of proportion water. -} } \usage{ data(CLUSexample) - -data(dem_example) } \description{ From Kyle Lochhead and Tyler Muhly's CLUS road simulation example. \code{SpatRaster} files created with the terra package must be saved with \code{\link[terra:wrap]{terra::wrap()}} and need to be unwrapped before they are used. \code{\link[=prepExData]{prepExData()}} does this. - -A list containing two rasters covering an area near Revelstoke, British -Columbia, Canada. \code{ex_elev} is elevation data and \code{ex_wat} is the proportion -of the cell that contains water. Both are subsets of data downloaded with the -geodata package at 30 arc seconds resolution.\code{SpatRaster} files created with -the terra package must be saved with \code{\link[terra:wrap]{terra::wrap()}} and need to be unwrapped -before they are used. \code{\link[=prepExData]{prepExData()}} does this. -} -\details{ -Elevation data are primarily from Shuttle Radar Topography Mission (SRTM), -specifically the hole-filled CGIAR-SRTM (90 m resolution) from -https://srtm.csi.cgiar.org/. - -Water data are derived from the ESA WorldCover data set at 0.3-seconds -resolution. (License CC BY 4.0). See https://esa-worldcover.org/en for more -information. } \examples{ CLUSexample prepExData(CLUSexample) -CLUSexample -prepExData(CLUSexample) -} -\references{ -Zanaga, D., Van De Kerchove, R., De Keersmaecker, W., Souverijns, -N., Brockmann, C., Quast, R., Wevers, J., Grosu, A., Paccini, A., Vergnaud, -S., Cartus, O., Santoro, M., Fritz, S., Georgieva, I., Lesiv, M., Carter, -S., Herold, M., Li, Linlin, Tsendbazar, N.E., Ramoino, F., Arino, O., 2021. -ESA WorldCover 10 m 2020 v100. doi:10.5281/zenodo.5571936. } \keyword{datasets} diff --git a/man/dem_example.Rd b/man/dem_example.Rd new file mode 100644 index 0000000..a8047f7 --- /dev/null +++ b/man/dem_example.Rd @@ -0,0 +1,45 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/dem_example.R +\docType{data} +\name{dem_example} +\alias{dem_example} +\title{Grade penalty example data} +\format{ +A named list with components: +\itemize{ +\item ex_elev: a \code{PackedSpatRaster} of elevation. +\item ex_wat: a \code{PackedSpatRaster} of proportion water. +} +} +\usage{ +data(dem_example) +} +\description{ +A list containing two rasters covering an area near Revelstoke, British +Columbia, Canada. \code{ex_elev} is elevation data and \code{ex_wat} is the proportion +of the cell that contains water. Both are subsets of data downloaded with the +geodata package at 30 arc seconds resolution.\code{SpatRaster} files created with +the terra package must be saved with \code{\link[terra:wrap]{terra::wrap()}} and need to be unwrapped +before they are used. \code{\link[=prepExData]{prepExData()}} does this. +} +\details{ +Elevation data are primarily from Shuttle Radar Topography Mission (SRTM), +specifically the hole-filled CGIAR-SRTM (90 m resolution) from +https://srtm.csi.cgiar.org/. + +Water data are derived from the ESA WorldCover data set at 0.3-seconds +resolution. (License CC BY 4.0). See https://esa-worldcover.org/en for more +information. +} +\examples{ +dem_example +prepExData(dem_example) +} +\references{ +Zanaga, D., Van De Kerchove, R., De Keersmaecker, W., Souverijns, +N., Brockmann, C., Quast, R., Wevers, J., Grosu, A., Paccini, A., Vergnaud, +S., Cartus, O., Santoro, M., Fritz, S., Georgieva, I., Lesiv, M., Carter, +S., Herold, M., Li, Linlin, Tsendbazar, N.E., Ramoino, F., Arino, O., 2021. +ESA WorldCover 10 m 2020 v100. doi:10.5281/zenodo.5571936. +} +\keyword{datasets}