From 82dbbc4a541459966d4971356915f5f117620ee9 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Mon, 11 Nov 2024 16:48:14 +0100 Subject: [PATCH 01/13] projectid --- leafgl.Rproj | 1 + 1 file changed, 1 insertion(+) diff --git a/leafgl.Rproj b/leafgl.Rproj index 60ab68b..ab84a52 100644 --- a/leafgl.Rproj +++ b/leafgl.Rproj @@ -1,4 +1,5 @@ Version: 1.0 +ProjectId: 86101ef8-f6ce-44c2-8cd5-8815a22f7175 RestoreWorkspace: Default SaveWorkspace: Default From 9b629ea228057e04b81836f97366b5acc0f962d6 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Mon, 11 Nov 2024 19:05:16 +0100 Subject: [PATCH 02/13] update badge urls & remove lazy data entry --- DESCRIPTION | 3 +-- README.Rmd | 8 ++++---- README.md | 45 +++++++++++++++++++++------------------------ 3 files changed, 26 insertions(+), 30 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1da2f81..9c2d894 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -28,8 +28,7 @@ Maintainer: Tim Appelhans Description: Provides bindings to the 'Leaflet.glify' JavaScript library which extends the 'leaflet' JavaScript library to render large data in the browser using 'WebGl'. License: MIT + file LICENSE Encoding: UTF-8 -LazyData: false -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 Imports: geojsonsf, htmltools, diff --git a/README.Rmd b/README.Rmd index 88f3b33..2e29eb0 100644 --- a/README.Rmd +++ b/README.Rmd @@ -14,11 +14,11 @@ knitr::opts_chunk$set( # leafgl - performant WebGL rendering for leaflet -[![Travis build status](https://travis-ci.org/r-spatial/leafgl.svg?branch=master)](https://travis-ci.org/r-spatial/leafgl) -[![monthly](http://cranlogs.r-pkg.org/badges/leafgl)](https://www.rpackages.io/package/leafgl) -[![total](http://cranlogs.r-pkg.org/badges/grand-total/leafgl)](https://www.rpackages.io/package/leafgl) +[![R-CMD-check](https://github.com/r-spatial/leafgl/workflows/R-CMD-check/badge.svg)](https://github.com/r-spatial/leafgl/actions) +[![cran checks](https://badges.cranchecks.info/worst/leafgl.svg)](https://cran.r-project.org/web/checks/check_results_leafgl.html) +![monthly](http://cranlogs.r-pkg.org/badges/leafgl) +![total](http://cranlogs.r-pkg.org/badges/grand-total/leafgl) [![CRAN](http://www.r-pkg.org/badges/version/leafgl?color=009999)](https://cran.r-project.org/package=leafgl) -[![status](https://tinyverse.netlify.com/badge/leafgl)](https://CRAN.R-project.org/package=leafgl) An R package for fast web gl rendering of features on leaflet maps. It's an R port of https://github.com/robertleeplummerjr/Leaflet.glify where diff --git a/README.md b/README.md index 55ad43e..769ef95 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,19 @@ # leafgl - performant WebGL rendering for leaflet - -[![R-CMD-check](https://github.com/r-spatial/leafgl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-spatial/leafgl/actions/workflows/R-CMD-check.yaml) -[![Codecov test coverage](https://codecov.io/gh/r-spatial/leafgl/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-spatial/leafgl?branch=master) - -[![monthly](http://cranlogs.r-pkg.org/badges/leafgl)](https://www.rpackages.io/package/leafgl) -[![total](http://cranlogs.r-pkg.org/badges/grand-total/leafgl)](https://www.rpackages.io/package/leafgl) +[![R-CMD-check](https://github.com/r-spatial/leafgl/workflows/R-CMD-check/badge.svg)](https://github.com/r-spatial/leafgl/actions) +[![cran +checks](https://badges.cranchecks.info/worst/leafgl.svg)](https://cran.r-project.org/web/checks/check_results_leafgl.html) +![monthly](http://cranlogs.r-pkg.org/badges/leafgl) +![total](http://cranlogs.r-pkg.org/badges/grand-total/leafgl) [![CRAN](http://www.r-pkg.org/badges/version/leafgl?color=009999)](https://cran.r-project.org/package=leafgl) -[![status](https://tinyverse.netlify.com/badge/leafgl)](https://CRAN.R-project.org/package=leafgl) - An R package for fast web gl rendering of features on leaflet maps. It’s an R port of where more detailed information/documentation can be found. Also, if you like -what you get here, make sure to star the original repo\! +what you get here, make sure to star the original repo! ------ +------------------------------------------------------------------------ ### Installation @@ -63,7 +60,7 @@ wait for a map that the browser isn’t able to render anyway… For starters, it doesn’t guarantee to be working tomorrow. At this stage `leafgl` is pre-alpha and under heavy development so things are likely to change frequently. For example, we are thinking about shorter funtion -names (e.g. `addGlPolygons` instead of the current `addGlifyPolygons`). +names (e.g. `addGlPolygons` instead of the current `addGlifyPolygons`). Additionally, we are still figuring out which pathway is best to use in order to pass data from R to the browser. As a result, rendering environments other than the browser (or RStudio viewer) may not work @@ -79,13 +76,13 @@ issue](https://github.com/r-spatial/leafgl/issues/4) ### What can I do to help? -A lot\! First and foremost you can use it as often as possible and -report issues/bugreports and/or feature request (see end of page for -details). If you have ideas on how to enhance functionality without -impacting performance too much and feel confident enough to provide pull -request, please don’t hesitate. Finally, if you have proficient -knowledge of JavaScript and want/know how to improve the package in any -way, we would very much love to hear from you\! +A lot! First and foremost you can use it as often as possible and report +issues/bugreports and/or feature request (see end of page for details). +If you have ideas on how to enhance functionality without impacting +performance too much and feel confident enough to provide pull request, +please don’t hesitate. Finally, if you have proficient knowledge of +JavaScript and want/know how to improve the package in any way, we would +very much love to hear from you! ### Example usage @@ -118,12 +115,12 @@ leaflet() %>%
------ +------------------------------------------------------------------------ #### Colouring points by value mapping For this we use `library(colourvalues)` because it can create color -voctors in the blink of an eye\! +voctors in the blink of an eye! ``` r library(leaflet) @@ -151,7 +148,7 @@ leaflet() %>%
------ +------------------------------------------------------------------------ #### 100k polygons on a map @@ -188,11 +185,11 @@ leaflet() %>%
------ +------------------------------------------------------------------------ ## Shiny -Thanks to \[@ColinFay\]() `leafgl` has +Thanks to [@ColinFay](https://github.com/ColinFay) `leafgl` has dedicated shiny functions. Given that what `leafgl` produces is a `leaflet` map, we only need to use `leafglOutput` in our `ui` call. In the `server` call we can simply use `renderLeaflet`. Here an example: @@ -232,7 +229,7 @@ shinyApp(ui, server)
------ +------------------------------------------------------------------------ ## Contact From 8a2df9ecb7873408d9ba2fe04c1b0410a378bd7d Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Mon, 11 Nov 2024 19:06:23 +0100 Subject: [PATCH 03/13] delete type entry from description --- DESCRIPTION | 1 - 1 file changed, 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 9c2d894..178e421 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,4 @@ Package: leafgl -Type: Package Title: High-Performance 'WebGl' Rendering for Package 'leaflet' Version: 0.2.1.9005 Authors@R: From 3fbe30314c553235efddad1a7382327edb2a10ff Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Tue, 12 Nov 2024 11:28:46 +0100 Subject: [PATCH 04/13] bump dev version 0.2.1.9006 --- DESCRIPTION | 2 +- NEWS | 2 +- NEWS.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 178e421..69efd95 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: leafgl Title: High-Performance 'WebGl' Rendering for Package 'leaflet' -Version: 0.2.1.9005 +Version: 0.2.1.9006 Authors@R: c(person(given = "Tim", family = "Appelhans", diff --git a/NEWS b/NEWS index 30fca91..c205212 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -leafgl 0.2.1.9005 (2023-09-08) +leafgl 0.2.1.9006 (2024-11-12) features and improvements diff --git a/NEWS.md b/NEWS.md index f36e145..8c97d3e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# leafgl 0.2.1.9005 (2023-09-08) +# leafgl 0.2.1.9006 (2024-11-12) #### ✨ features and improvements From beda3bd1e67fdd25403e068f509eb3b1e7244cb3 Mon Sep 17 00:00:00 2001 From: olivroy <52606734+olivroy@users.noreply.github.com> Date: Wed, 13 Nov 2024 08:08:48 -0500 Subject: [PATCH 05/13] Add links to DESCRIPTION --- DESCRIPTION | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 69efd95..b26de8f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,7 +23,6 @@ Authors@R: family = "Gatscha", role = "ctb", email = "sebastian_gatscha@gmx.at")) -Maintainer: Tim Appelhans Description: Provides bindings to the 'Leaflet.glify' JavaScript library which extends the 'leaflet' JavaScript library to render large data in the browser using 'WebGl'. License: MIT + file LICENSE Encoding: UTF-8 @@ -39,3 +38,5 @@ Suggests: colourvalues, shiny, testthat (>= 2.1.0) +URL: https://github.com/r-spatial/leafgl +BugReports:https://github.com/r-spatial/leafgl/issues From c91ef1d8f88cfe234e8e60d7dfc3c70be079d15c Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 16:44:17 +0100 Subject: [PATCH 06/13] setup github pages --- .Rbuildignore | 3 +++ .github/workflows/pkgdown.yaml | 9 +++++---- .gitignore | 1 + DESCRIPTION | 4 ++-- _pkgdown.yml | 4 ++++ 5 files changed, 15 insertions(+), 6 deletions(-) create mode 100644 _pkgdown.yml diff --git a/.Rbuildignore b/.Rbuildignore index e335b9f..c49ce1e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,6 @@ ^README\.Rmd$ ^\.github$ ^codecov\.yml$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml index ed7650c..bfc9f4d 100644 --- a/.github/workflows/pkgdown.yaml +++ b/.github/workflows/pkgdown.yaml @@ -4,12 +4,13 @@ on: push: branches: [main, master] pull_request: - branches: [main, master] release: types: [published] workflow_dispatch: -name: pkgdown +name: pkgdown.yaml + +permissions: read-all jobs: pkgdown: @@ -22,7 +23,7 @@ jobs: permissions: contents: write steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: r-lib/actions/setup-pandoc@v2 @@ -41,7 +42,7 @@ jobs: - name: Deploy to GitHub pages 🚀 if: github.event_name != 'pull_request' - uses: JamesIves/github-pages-deploy-action@v4.4.1 + uses: JamesIves/github-pages-deploy-action@v4.5.0 with: clean: false branch: gh-pages diff --git a/.gitignore b/.gitignore index 5b6a065..234f028 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .Rhistory .RData .Ruserdata +docs diff --git a/DESCRIPTION b/DESCRIPTION index b26de8f..f4fcecb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -38,5 +38,5 @@ Suggests: colourvalues, shiny, testthat (>= 2.1.0) -URL: https://github.com/r-spatial/leafgl -BugReports:https://github.com/r-spatial/leafgl/issues +URL: https://github.com/r-spatial/leafgl, https://r-spatial.github.io/leafgl/ +BugReports: https://github.com/r-spatial/leafgl/issues diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..48599a4 --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://r-spatial.github.io/leafgl/ +template: + bootstrap: 5 + From 351424695bfbf0985f9cc8cf741c743264df13a7 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 16:44:42 +0100 Subject: [PATCH 07/13] bump dev version 0.2.1.9007 --- DESCRIPTION | 2 +- NEWS | 2 +- NEWS.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index f4fcecb..d13b535 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: leafgl Title: High-Performance 'WebGl' Rendering for Package 'leaflet' -Version: 0.2.1.9006 +Version: 0.2.1.9007 Authors@R: c(person(given = "Tim", family = "Appelhans", diff --git a/NEWS b/NEWS index c205212..fdc8d29 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -leafgl 0.2.1.9006 (2024-11-12) +leafgl 0.2.1.9007 (2024-11-13) features and improvements diff --git a/NEWS.md b/NEWS.md index 8c97d3e..dd29c70 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# leafgl 0.2.1.9006 (2024-11-12) +# leafgl 0.2.1.9007 (2024-11-13) #### ✨ features and improvements From a56dcbf2f2e912ba69c4053585590cd4ad607b58 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 16:56:22 +0100 Subject: [PATCH 08/13] remove travis --- .travis.yml | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 75b5759..0000000 --- a/.travis.yml +++ /dev/null @@ -1,22 +0,0 @@ -# R for travis: see documentation at https://docs.travis-ci.com/user/languages/r -language: r -sudo: required -dist: xenial -cache: packages -latex: true - -addons: - apt: - sources: - - sourceline: 'ppa:ubuntugis/ubuntugis-unstable' - packages: - - libproj-dev - - libgeos-dev - - libgdal-dev - - libudunits2-dev - - netcdf-bin # for stars netcdf dep - -r: - - release - - devel - - oldrel From 4fef6d8bcae5b6218547db8164e6cabf5343a81c Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 16:56:43 +0100 Subject: [PATCH 09/13] add @olivroy and update news --- DESCRIPTION | 5 ++++- NEWS.md | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index d13b535..ecc23e3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -22,7 +22,10 @@ Authors@R: person(given = "Sebastian", family = "Gatscha", role = "ctb", - email = "sebastian_gatscha@gmx.at")) + email = "sebastian_gatscha@gmx.at"), + person(give = "Olivier", + family = "Roy", + role = "ctb")) Description: Provides bindings to the 'Leaflet.glify' JavaScript library which extends the 'leaflet' JavaScript library to render large data in the browser using 'WebGl'. License: MIT + file LICENSE Encoding: UTF-8 diff --git a/NEWS.md b/NEWS.md index dd29c70..11dae74 100644 --- a/NEWS.md +++ b/NEWS.md @@ -8,8 +8,12 @@ #### 💬 documentation etc + * we now have pckgdown site - Thanks to @olivroy #102 + #### 🍬 miscellaneous + * remove obsolete .travis.yml + ## leafgl 0.2.1 From 33d368a2e6e8522fb3c5948ba093edd6bf719fe8 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 16:56:56 +0100 Subject: [PATCH 10/13] bump dev version 0.2.1.9008 --- DESCRIPTION | 2 +- NEWS | 6 +++++- NEWS.md | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ecc23e3..b853daf 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: leafgl Title: High-Performance 'WebGl' Rendering for Package 'leaflet' -Version: 0.2.1.9007 +Version: 0.2.1.9008 Authors@R: c(person(given = "Tim", family = "Appelhans", diff --git a/NEWS b/NEWS index fdc8d29..e24c584 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -leafgl 0.2.1.9007 (2024-11-13) +leafgl 0.2.1.9008 (2024-11-13) features and improvements @@ -8,8 +8,12 @@ bug fixes documentation etc + * we now have pckgdown site - Thanks to @olivroy #102 + miscellaneous + * remove obsolete .travis.yml + leafgl 0.2.1 diff --git a/NEWS.md b/NEWS.md index 11dae74..fc768a7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# leafgl 0.2.1.9007 (2024-11-13) +# leafgl 0.2.1.9008 (2024-11-13) #### ✨ features and improvements From c3d546ecb459c2d72b674c27ef19613311885b14 Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 17:20:52 +0100 Subject: [PATCH 11/13] typo --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index b853daf..35cd39c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -23,7 +23,7 @@ Authors@R: family = "Gatscha", role = "ctb", email = "sebastian_gatscha@gmx.at"), - person(give = "Olivier", + person(given = "Olivier", family = "Roy", role = "ctb")) Description: Provides bindings to the 'Leaflet.glify' JavaScript library which extends the 'leaflet' JavaScript library to render large data in the browser using 'WebGl'. From d7f46379c1c62635711b3ed7882d8f95c2c58bbf Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 17:21:04 +0100 Subject: [PATCH 12/13] bump dev version 0.2.1.9009 --- DESCRIPTION | 2 +- NEWS | 2 +- NEWS.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 35cd39c..4610e7d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: leafgl Title: High-Performance 'WebGl' Rendering for Package 'leaflet' -Version: 0.2.1.9008 +Version: 0.2.1.9009 Authors@R: c(person(given = "Tim", family = "Appelhans", diff --git a/NEWS b/NEWS index e24c584..a0fa7be 100644 --- a/NEWS +++ b/NEWS @@ -1,4 +1,4 @@ -leafgl 0.2.1.9008 (2024-11-13) +leafgl 0.2.1.9009 (2024-11-13) features and improvements diff --git a/NEWS.md b/NEWS.md index fc768a7..c1d1741 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# leafgl 0.2.1.9008 (2024-11-13) +# leafgl 0.2.1.9009 (2024-11-13) #### ✨ features and improvements From 8cb22f781491025199b520a04a371837c48ad20d Mon Sep 17 00:00:00 2001 From: Tim Appelhans Date: Wed, 13 Nov 2024 17:35:57 +0100 Subject: [PATCH 13/13] bump version 0.2.2 --- DESCRIPTION | 2 +- NEWS | 6 +----- NEWS.md | 8 ++------ 3 files changed, 4 insertions(+), 12 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 4610e7d..48351c0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: leafgl Title: High-Performance 'WebGl' Rendering for Package 'leaflet' -Version: 0.2.1.9009 +Version: 0.2.2 Authors@R: c(person(given = "Tim", family = "Appelhans", diff --git a/NEWS b/NEWS index a0fa7be..d80b363 100644 --- a/NEWS +++ b/NEWS @@ -1,6 +1,4 @@ -leafgl 0.2.1.9009 (2024-11-13) - -features and improvements +leafgl 0.2.2 (2024-11-13) bug fixes @@ -14,7 +12,6 @@ miscellaneous * remove obsolete .travis.yml - leafgl 0.2.1 new features: @@ -37,7 +34,6 @@ new features: * expose additional JavaScript arguments in addGlPoints via magic dots. #54 & #60 - leafgl 0.1.1 initial release. diff --git a/NEWS.md b/NEWS.md index c1d1741..193e09d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,4 @@ -# leafgl 0.2.1.9009 (2024-11-13) - -#### ✨ features and improvements +# leafgl 0.2.2 (2024-11-13) #### 🐛 bug fixes @@ -14,7 +12,6 @@ * remove obsolete .travis.yml - ## leafgl 0.2.1 new features: @@ -24,7 +21,7 @@ new features: miscallaneous: * all methods now have a pane argument to control layer ordering (thanks to @trafficonese). #67 #64 - + ## leafgl 0.2.0 miscallaneous: @@ -37,7 +34,6 @@ new features: * expose additional JavaScript arguments in addGlPoints via magic dots. #54 & #60 - ## leafgl 0.1.1 initial release.