From 21ff802017cf4e23e25b0864b2baa9f48b811936 Mon Sep 17 00:00:00 2001 From: Sebastian Gatscha Date: Sun, 1 Sep 2024 13:41:18 +0200 Subject: [PATCH] docs --- .Rbuildignore | 2 ++ R/buildings.R | 7 +++---- man/addBuildings.Rd | 7 +++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 01b71730..90264787 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -18,3 +18,5 @@ ^newfeatures/.* ^package\.json$ ^package-lock\.json$ +^revdep$ +^bower_components$ diff --git a/R/buildings.R b/R/buildings.R index ce495f8d..133fb0e5 100644 --- a/R/buildings.R +++ b/R/buildings.R @@ -19,8 +19,8 @@ buildingsDependency <- function() { #' @param buildingURL The URL template for the building data. Default is the OSM Buildings tile server: \cr #' \code{"https://{s}.data.osmbuildings.org/0.2/59fcc2e8/tile/{z}/{x}/{y}.json"}. #' @param group The name of the group the buildings will be added to. -#' @param eachFn A JavaScript function (using \code{\link[htmlwidgets]{JS}}) that will be called for each building feature. Use this to apply custom logic to each feature. -#' @param clickFn A JavaScript function (using \code{\link[htmlwidgets]{JS}}) that will be called when a building is clicked. Use this to handle click events on buildings. +#' @param eachFn A JavaScript function (using \code{\link[leaflet]{JS}}) that will be called for each building feature. Use this to apply custom logic to each feature. +#' @param clickFn A JavaScript function (using \code{\link[leaflet]{JS}}) that will be called when a building is clicked. Use this to handle click events on buildings. #' @param data A GeoJSON object containing Polygon features representing the buildings. The properties of these polygons can include attributes like \code{height}, \code{color}, \code{roofColor}, and others as specified in the OSM Buildings documentation. #' #' @details @@ -36,8 +36,7 @@ buildingsDependency <- function() { #' \item \strong{roofShape} #' \item \strong{roofHeight} #' } -#' -#' See the OSM Wiki: \href{https://wiki.openstreetmap.org/wiki/Simple_3D_Buildings} +#' See the OSM Wiki: \href{https://wiki.openstreetmap.org/wiki/Simple_3D_Buildings}{Simple_3D_Buildings} #' #' @seealso \url{https://github.com/kekscom/osmbuildings/} for more details on the OSM Buildings plugin and available properties. #' @family OSM-Buildings Plugin diff --git a/man/addBuildings.Rd b/man/addBuildings.Rd index 56ba1b86..56770ff7 100644 --- a/man/addBuildings.Rd +++ b/man/addBuildings.Rd @@ -21,9 +21,9 @@ addBuildings( \item{group}{The name of the group the buildings will be added to.} -\item{eachFn}{A JavaScript function (using \code{\link[htmlwidgets]{JS}}) that will be called for each building feature. Use this to apply custom logic to each feature.} +\item{eachFn}{A JavaScript function (using \code{\link[leaflet]{JS}}) that will be called for each building feature. Use this to apply custom logic to each feature.} -\item{clickFn}{A JavaScript function (using \code{\link[htmlwidgets]{JS}}) that will be called when a building is clicked. Use this to handle click events on buildings.} +\item{clickFn}{A JavaScript function (using \code{\link[leaflet]{JS}}) that will be called when a building is clicked. Use this to handle click events on buildings.} \item{data}{A GeoJSON object containing Polygon features representing the buildings. The properties of these polygons can include attributes like \code{height}, \code{color}, \code{roofColor}, and others as specified in the OSM Buildings documentation.} } @@ -43,8 +43,7 @@ The `data` parameter allows you to provide custom building data as a GeoJSON obj \item \strong{roofShape} \item \strong{roofHeight} } - -See the OSM Wiki: \href{https://wiki.openstreetmap.org/wiki/Simple_3D_Buildings} +See the OSM Wiki: \href{https://wiki.openstreetmap.org/wiki/Simple_3D_Buildings}{Simple_3D_Buildings} } \seealso{ \url{https://github.com/kekscom/osmbuildings/} for more details on the OSM Buildings plugin and available properties.