docs: Convert website to use {pkgdown}

.Rbuildignore

@@ -33,3 +33,8 @@
 ^revdep$
 ^CRAN-SUBMISSION$
 ^_dev$
+^vignettes/articles$
+^_pkgdown\.yml$
+^pkgdown$
+docs_old$
+

.github/workflows/R-CMD-check.yaml

@@ -13,9 +13,8 @@ on:
 name: Package checks
 
 jobs:
-  ## Website is not pkgdown; Run `source("tools/docs_update.R")` on release!
-  # website:
-  #   uses: rstudio/shiny-workflows/.github/workflows/website.yaml@v1
+  website:
+     uses: rstudio/shiny-workflows/.github/workflows/website.yaml@v1
   routine:
     uses: rstudio/shiny-workflows/.github/workflows/routine.yaml@v1
     with:

.gitignore

@@ -11,3 +11,5 @@ revdep/checks.noindex
 revdep/library.noindex
 revdep/data.sqlite
 viztest-*
+inst/doc
+docs

DESCRIPTION

@@ -71,12 +71,15 @@ Suggests:
     purrr,
     R6,
     RJSONIO,
+    rmarkdown,
     s2,
     sf (>= 0.9-6),
     shiny,
     terra,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+Config/Needs/website: geojsonio, ncdf4, tidyverse/tidytemplate
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
+VignetteBuilder: knitr

NAMESPACE

@@ -38,6 +38,9 @@ S3method(polygonData,matrix)
 S3method(polygonData,sf)
 S3method(polygonData,sfc)
 S3method(polygonData,sfg)
+S3method(toPaletteFunc,"function")
+S3method(toPaletteFunc,character)
+S3method(toPaletteFunc,matrix)
 S3method(to_multipolygon,Lines)
 S3method(to_multipolygon,MULTILINESTRING)
 S3method(to_multipolygon,MULTIPOLYGON)

NEWS.md

@@ -2,6 +2,8 @@
 
 * Fixed #893: Correctly call `terra::crs()` when checking the CRS of a `SpatVector` object in `pointData()` or `polygonData()` (thanks @mkoohafkan, #894).
 
+* `{leaflet}` now has a brand new pkgdown site (@olivroy, #902)
+
 # leaflet 2.2.1
 
 * When `addProviderTiles()` is used with `{leaflet.providers}` version 2.0.0 or later, the `leaflet-providers` HTML dependency produced can be correctly cached by knitr. When used with older versions of `{leaflet.providers}`, the HTML dependency uses temp files that break knitr's caching mechanism (thanks @qdread, @jaredlander; #884).

R/colors.R

@@ -323,6 +323,7 @@ brewer_pal <- function(palette, n = NULL) {
 
 # Strings are interpreted as color names, unless length is 1 and it's the name
 # of an RColorBrewer palette that is marked as qualitative
+#' @export
 toPaletteFunc.character <- function(pal, alpha, nlevels) {
   if (length(pal) == 1 && pal %in% row.names(RColorBrewer::brewer.pal.info)) {
     paletteInfo <- RColorBrewer::brewer.pal.info[pal, ]
@@ -341,11 +342,13 @@ toPaletteFunc.character <- function(pal, alpha, nlevels) {
 }
 
 # Accept colorRamp style matrix
+#' @export
 toPaletteFunc.matrix <- function(pal, alpha, nlevels) {
   toPaletteFunc(rgb(pal, maxColorValue = 255), alpha = alpha)
 }
 
 # If a function, just assume it's already a function over [0-1]
+#' @export
 toPaletteFunc.function <- function(pal, alpha, nlevels) {
   pal
 }

R/leaflet-package.R

@@ -24,7 +24,6 @@ NULL
 release_bullets <- function() {
   c(
     "Update static imports: `staticimports::import()`",
-    "Rebuild website: `source(\"scripts/docs_update.R\")`",
     'Check Super Zip example: `shiny::runGitHub("rstudio/shiny-examples", subdir = "063-superzip-example")`',
     "Check licenses if bundled dependencies were updated",
     '`source("scripts/viztest.R")`'

_pkgdown.yml

@@ -0,0 +1,12 @@
+url: https://rstudio.github.io/leaflet/
+
+development:
+  mode: auto
+
+template:
+  package: tidytemplate
+  bootstrap: 5
+  bslib:
+    primary: "#199900"
+    navbar-background: "#f8f8f8"
+  trailing_slash_redirect: true

inst/examples/highlight-polygons.R

@@ -2,8 +2,7 @@
 #' An example to show how to highlight polygons on hover using `onRender`
 #'
 library(sp)
-library(albersusa)
-library(maptools)
+library(albersusa) # Requires rgdal / rgeos archived.
 library(leaflet)
 
 spdf <- rmapshaper::ms_simplify(usa_composite())

inst/examples/proj4Leaflet.R

@@ -82,7 +82,7 @@ leaflet(options = leafletOptions(
 
 
 library(sp)
-library(albersusa)
+library(albersusa) # requires rgdal and maptools (archived)
 spdf <- rmapshaper::ms_simplify(usa_composite())
 pal <- colorNumeric(
   palette = "Blues",

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R

docs/basemaps.Rmd → vignettes/articles/basemaps.Rmd

@@ -1,7 +1,14 @@
 ---
-pagetitle: Leaflet for R - Using Basemaps
+title: "Using Basemaps"
 ---
 
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
 ## Using Basemaps
 
 Leaflet supports basemaps using [map tiles](https://www.mapbox.com/guides/how-web-maps-work/), popularized by Google Maps and now used by nearly all interactive web maps.
@@ -11,6 +18,7 @@ Leaflet supports basemaps using [map tiles](https://www.mapbox.com/guides/how-we
 The easiest way to add tiles is by calling `addTiles()` with no arguments; by default, [OpenStreetMap](https://www.openstreetmap.org/) tiles are used.
 
 ```{r fig.height=2.5}
+library(leaflet)
 m <- leaflet() %>% setView(lng = -71.0589, lat = 42.3601, zoom = 12)
 m %>% addTiles()
 ```

docs/choropleths.Rmd → vignettes/articles/choropleths.Rmd

@@ -1,8 +1,13 @@
 ---
-pagetitle: Leaflet for R - Choropleths
+title: "Choropleths"
 ---
 
-## Choropleths
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
 
 Making choropleths with leaflet is easy. In this example, we'll duplicate the [step-by-step choropleth tutorial](https://leafletjs.com/examples/choropleth/) from the Leaflet.js website.
 

docs/colors.Rmd → vignettes/articles/colors.Rmd

@@ -1,7 +1,14 @@
 ---
-pagetitle: Leaflet for R - Colors
+title: "Add color to a leaflet"
 ---
 
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
 ## Colors
 
 An important part of spatial visualization is mapping variables to colors. While R has no shortage of built-in functionality to map values to colors, we found that there was enough friction in the process to warrant introducing some wrapper functions that do a lot of the work for you.

docs/extending.Rmd → vignettes/articles/extending.Rmd

@@ -1,7 +1,14 @@
 ---
-pagetitle: Leaflet for R - Extending Leaflet
+title: "Extending Leaflet"
 ---
 
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
 ## Extending Leaflet package
 
 The Leaflet Javascript library has a plethora of [plugins](leafletjs.com/plugins) available that extend the functionality of the core package. We have incorporated a chosen few in the R package. It may be desirable to use plugins availble outside of what are supported by this pakage.

docs/json.Rmd → vignettes/articles/json.Rmd

@@ -1,14 +1,15 @@
 ---
-pagetitle: Leaflet for R - Working with GeoJSON & TopoJSON
+title: "Working with GeoJSON & TopoJSON"
 ---
 
+
 ## Working with GeoJSON & TopoJSON
 
 For working with GeoJSON/TopoJSON data you have two options: either read it into `sp` objects; or use the `addGeoJSON()` and `addTopoJSON()` functions.
 
 ### Reading as `sp`
 
-The first approach is to use either `rgdal` or `geojsonio` (packages) to read GeoJSON/TopoJSON as `sp` objects. Then, you can use the full functionality of [polygons](shapes.html), [markers](markers.html), [colors](colors.html), [legends](legends.html), etc.
+The first approach is to use either `sf` or `geojsonio` (packages) to read GeoJSON/TopoJSON as `sp` objects. Then, you can use the full functionality of [polygons](shapes.html), [markers](markers.html), [colors](colors.html), [legends](legends.html), etc.
 
 ```{r, include = FALSE}
 library(leaflet)
@@ -18,7 +19,7 @@ library(magrittr)
 ```{r message=FALSE,warning=FALSE}
 # From http://eric.clst.org/Stuff/USGeoJSON and
 # https://en.wikipedia.org/wiki/List_of_United_States_counties_and_county_equivalents
-nycounties <- rgdal::readOGR("https://rstudio.github.io/leaflet/json/nycounties.geojson") 
+nycounties <- sf::read_sf("https://rstudio.github.io/leaflet/json/nycounties.geojson") 
 # Or use the geojsonio equivalent:
 # nycounties <- geojsonio::geojson_read("https://rstudio.github.io/leaflet/json/nycounties.geojson", what = "sp") 
 
@@ -70,6 +71,7 @@ The previous example demonstrated the style arguments. Below is a more involved
 ```{r echo=FALSE,warning=FALSE,message=FALSE}
 library(jsonlite, quietly = TRUE)
 ```
+
 ```{r}
 library(jsonlite)
 

docs/legends.Rmd → vignettes/articles/legends.Rmd

@@ -1,8 +1,14 @@
 ---
-pagetitle: Leaflet for R - Legends
+title: "Legends"
 ---
 
-## Legends
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
 
 The Leaflet package includes convenience functions for creating color legends. In this section, we will build on the example from the [Colors](colors.html) page.
 

docs/markers.Rmd → vignettes/articles/markers.Rmd

@@ -1,8 +1,17 @@
 ---
-pagetitle: Leaflet for R - Markers
+title: "Markers"
 ---
 
-## Markers
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r,echo=FALSE}
+library(leaflet)
+```
 
 Use markers to call out points on the map. Marker locations are expressed in latitude/longitude coordinates, and can either appear as icons or as circles.
 

docs/morefeatures.Rmd → vignettes/articles/morefeatures.Rmd

@@ -1,7 +1,8 @@
 ---
-pagetitle: Leaflet for R - More features
+title: "More features"
 ---
 
+
 ## Additional features
 
 - Add-ons

docs/popups.Rmd → vignettes/articles/popups.Rmd

@@ -1,7 +1,18 @@
 ---
-pagetitle: Leaflet for R - Popups and Labels
+title: "Popups and Labels"
 ---
 
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r, include = FALSE}
+library(leaflet)
+```
+
 ## Popups
 
 Popups are small boxes containing arbitrary HTML, that point to a specific point on the map.
@@ -94,4 +105,4 @@ leaflet() %>% addTiles() %>% setView(-118.456554, 34.09, 13) %>%
 
 #### Labels without markers
 
-You can create labels without the accompanying markers using the `addLabelOnlyMarkers` function.
+You can create labels without the accompanying markers using the `addLabelOnlyMarkers()` function.

docs/projections.Rmd → vignettes/articles/projections.Rmd

@@ -1,8 +1,17 @@
 ---
-pagetitle: Leaflet for R - Using Projections
+title: "Working with projections in Leaflet"
 ---
 
-## Working with projections in Leaflet
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r, include = FALSE}
+library(leaflet)
+```
 
 **Note:** This functionality is for advanced users and may not be supported across all functions (for example, `addRasterImage` currently works only with EPSG:3857 Web Mercator).
 
@@ -69,10 +78,9 @@ While tiles must be in the same projection as used in the `leafletCRS` function,
 
 This example uses [EPSG:2163](http://epsg.io/2163) (US National Atlas Equal Area projection). The dataset we use (`usa_sf` from the `albersusa` package, though we're not actually using Albers projection here) has Alaska and Hawaii moved closer to mainland US as well as rotated and resized accordingly.
 
-```{r message=FALSE,warning=FALSE}
+```{r message=FALSE,warning=FALSE,eval=FALSE}
 library(sp)
-library(albersusa)
-
+library(albersusa) # not possible to install due to rgdal archival.
 spdf <- rmapshaper::ms_simplify(usa_sf(), keep = 0.1)
 pal <- colorNumeric("Blues", domain = spdf$pop_2014)
 epsg2163 <- leafletCRS(

docs/raster.Rmd → vignettes/articles/raster.Rmd

@@ -1,8 +1,13 @@
 ---
-pagetitle: Leaflet for R - Raster Images
+title: "Raster Images"
 ---
 
-## Raster Images
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
 
 Two-dimensional `SpatRaster` objects (from the [`terra` package](https://CRAN.R-project.org/package=terra)) or `RasterLayer` objects (from the [`raster` package](https://CRAN.R-project.org/package=raster)) can be turned into images and added to Leaflet maps using the `addRasterImage` function.
 
@@ -41,12 +46,13 @@ suppressPackageStartupMessages({
   library(raster)
   r <- suppressWarnings(raster("nc/oisst-sst.nc"))
 })
+library(leaflet)
 # ncdf4 emits partial match warnings
 ```
 
 ```{r eval=FALSE}
 library(raster)
-
+library(leaflet)
 r <- raster("nc/oisst-sst.nc")
 ```