From 7e2d7c03f35125634f3970d1d171e8c626b2c50a Mon Sep 17 00:00:00 2001 From: Sebastian Gatscha Date: Sun, 12 Jan 2025 12:50:23 +0100 Subject: [PATCH] fix: spelling + examples --- R/layergroupcollision.R | 10 +++---- ...oupCollision.Rd => LayerGroupCollision.Rd} | 29 ++++++++++--------- 2 files changed, 20 insertions(+), 19 deletions(-) rename man/{LayerroupCollision.Rd => LayerGroupCollision.Rd} (69%) diff --git a/R/layergroupcollision.R b/R/layergroupcollision.R index 7ae1e91..40a9a0a 100644 --- a/R/layergroupcollision.R +++ b/R/layergroupcollision.R @@ -16,7 +16,7 @@ layergroupCollisionDependency <- function() { ) } -#' Add LayerGroup Collision Plugin to Leaflet Map +#' Add LayerGroup Collision Plugin #' #' @description Integrates the LayerGroup Collision plugin into a Leaflet map, #' which hides overlapping markers and only displays the first added marker in a @@ -34,7 +34,7 @@ layergroupCollisionDependency <- function() { #' @inheritParams addDivicon #' @references \url{https://github.com/MazeMap/Leaflet.LayerGroup.Collision} #' -#' @name LayerroupCollision +#' @name LayerGroupCollision #' @examples #' library(leaflet) #' library(sf) @@ -42,16 +42,16 @@ layergroupCollisionDependency <- function() { #' #' df <- sf::st_as_sf(atlStorms2005) #' df <- suppressWarnings(st_cast(df, "POINT")) -#' df <- df[sample(1:nrow(df), 150, replace = FALSE), ] #' df$classes <- sample(x = 1:5, nrow(df), replace = TRUE) #' #' leaflet() %>% #' addProviderTiles("CartoDB.Positron") %>% #' leaflet::addLayersControl(overlayGroups = c("Labels")) %>% +#' addPolylines(data = sf::st_as_sf(atlStorms2005), label = ~Name) %>% #' addLayerGroupCollision( -#' data = df, +#' data = df, margin = 40, #' html = ~ paste0( -#' '
', +#' '
', #' '
', Name, "
", #' '
MaxWind: ', MaxWind, "
", #' "
" diff --git a/man/LayerroupCollision.Rd b/man/LayerGroupCollision.Rd similarity index 69% rename from man/LayerroupCollision.Rd rename to man/LayerGroupCollision.Rd index b0b0a4f..4dc53d6 100644 --- a/man/LayerroupCollision.Rd +++ b/man/LayerGroupCollision.Rd @@ -1,9 +1,9 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/layergroupcollision.R -\name{LayerroupCollision} -\alias{LayerroupCollision} +\name{LayerGroupCollision} +\alias{LayerGroupCollision} \alias{addLayerGroupCollision} -\title{Add LayerGroup Collision Plugin to Leaflet Map} +\title{Add LayerGroup Collision Plugin} \usage{ addLayerGroupCollision( map, @@ -47,21 +47,22 @@ library(leaflet.extras2) df <- sf::st_as_sf(atlStorms2005) df <- suppressWarnings(st_cast(df, "POINT")) -df <- df[sample(1:nrow(df), 150, replace = FALSE),] -df$classes = sample(x = 1:5, nrow(df), replace = TRUE) +df$classes <- sample(x = 1:5, nrow(df), replace = TRUE) leaflet() \%>\% addProviderTiles("CartoDB.Positron") \%>\% leaflet::addLayersControl(overlayGroups = c("Labels")) \%>\% - addLayerGroupCollision(data = df - , html = ~paste0( - '
', - '
', Name, '
', - '
MaxWind: ', MaxWind, '
', - '
' - ) - , className = ~paste0("my-label my-label-", classes) - , group = "Labels" + addPolylines(data = sf::st_as_sf(atlStorms2005), label = ~Name) \%>\% + addLayerGroupCollision( + data = df, margin = 40, + html = ~ paste0( + '
', + '
', Name, "
", + '
MaxWind: ', MaxWind, "
", + "
" + ), + className = ~ paste0("my-label my-label-", classes), + group = "Labels" ) } \references{