Skip to content

Commit

Permalink
Merge branch 'master' into fixlabels
Browse files Browse the repository at this point in the history
  • Loading branch information
trafficonese authored Nov 29, 2024
2 parents 3e9d39c + 8cb22f7 commit f978f87
Show file tree
Hide file tree
Showing 11 changed files with 77 additions and 80 deletions.
3 changes: 3 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@
^README\.Rmd$
^\.github$
^codecov\.yml$
^_pkgdown\.yml$
^docs$
^pkgdown$
9 changes: 5 additions & 4 deletions .github/workflows/pkgdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -22,7 +23,7 @@ jobs:
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

Expand All @@ -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
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
.Rhistory
.RData
.Ruserdata
docs
22 changes: 0 additions & 22 deletions .travis.yml

This file was deleted.

14 changes: 8 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Package: leafgl
Type: Package
Title: High-Performance 'WebGl' Rendering for Package 'leaflet'
Version: 0.2.1.9005
Version: 0.2.2
Authors@R:
c(person(given = "Tim",
family = "Appelhans",
Expand All @@ -23,13 +22,14 @@ Authors@R:
person(given = "Sebastian",
family = "Gatscha",
role = "ctb",
email = "[email protected]"))
Maintainer: Tim Appelhans <[email protected]>
email = "[email protected]"),
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'.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: false
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Imports:
htmltools,
leaflet,
Expand All @@ -40,3 +40,5 @@ Suggests:
colourvalues,
shiny,
testthat (>= 2.1.0)
URL: https://github.com/r-spatial/leafgl, https://r-spatial.github.io/leafgl/
BugReports: https://github.com/r-spatial/leafgl/issues
23 changes: 14 additions & 9 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
leafgl 0.2.1.9005 (2023-09-08)
leafgl development-version

* Added some @details for Shiny click and mouseover events and their corresponding input. #77
* Use `@inheritParams leaflet::**` for identical function arguments

miscellaneous

* update upstream javascript dependency to 3.3.0. #49
Note: If you previously used the workaround `L.glify.Shapes.instances.splice(0, 1)`, please remove it with this new version.
* unified / simplified the dependency functions/calls


features and improvements
leafgl 0.2.2 (2024-11-13)

* Switched from `jsonify` and `geojsonsf` to `yyjsonr`
* New method *clearGlGroup* removes a group from leaflet and the Leaflet.Glify instances.
Expand All @@ -20,15 +30,11 @@ bug fixes

documentation etc

* Added some @details for Shiny click and mouseover events and their corresponding input. #77
* Use `@inheritParams leaflet::**` for identical function arguments
* we now have pckgdown site - Thanks to @olivroy #102

miscellaneous

* update upstream javascript dependency to 3.3.0. #49
Note: If you previously used the workaround `L.glify.Shapes.instances.splice(0, 1)`, please remove it with this new version.
* unified / simplified the dependency functions/calls

* remove obsolete .travis.yml

leafgl 0.2.1

Expand All @@ -52,7 +58,6 @@ new features:

* expose additional JavaScript arguments in addGlPoints via magic dots. #54 & #60


leafgl 0.1.1

initial release.
27 changes: 16 additions & 11 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# leafgl 0.2.1.9005 (2023-09-08)
# leafgl dev-version

#### ✨ features and improvements
- Added some @details for Shiny click and mouseover events and their corresponding input. [#77](https://github.com/r-spatial/leafgl/issues/77)
- Use `@inheritParams leaflet::**` for identical function arguments
- unified / simplified the dependency functions/calls

#### 🍬 miscellaneous

- update upstream javascript dependency to 3.3.0. [#49](https://github.com/r-spatial/leafgl/issues/49)
⚠️If you previously used the workaround `L.glify.Shapes.instances.splice(0, 1)`, please remove it with this new version.


# leafgl 0.2.2 (2024-11-13)

- Switched from `jsonify` and `geojsonsf` to `yyjsonr`
- New method `clearGlGroup` removes a group from leaflet and the Leaflet.Glify instances.
Expand All @@ -19,16 +29,11 @@

#### 💬 documentation etc

- Added some @details for Shiny click and mouseover events and their corresponding input. [#77](https://github.com/r-spatial/leafgl/issues/77)
- Use `@inheritParams leaflet::**` for identical function arguments
* we now have pckgdown site - Thanks to @olivroy #102

#### 🍬 miscellaneous

- update upstream javascript dependency to 3.3.0. [#49](https://github.com/r-spatial/leafgl/issues/49)

⚠️If you previously used the workaround `L.glify.Shapes.instances.splice(0, 1)`, please remove it with this new version.

- unified / simplified the dependency functions/calls
* remove obsolete .travis.yml

## leafgl 0.2.1

Expand All @@ -38,7 +43,7 @@ new features:

miscallaneous:

- all methods now have a pane argument to control layer ordering (thanks to @trafficonese). [#67](https://github.com/r-spatial/leafgl/issues/67) [#64](https://github.com/r-spatial/leafgl/issues/64)
* all methods now have a pane argument to control layer ordering (thanks to @trafficonese). #67 #64

## leafgl 0.2.0

Expand All @@ -50,7 +55,7 @@ miscallaneous:

new features:

- expose additional JavaScript arguments in addGlPoints via magic dots. [#54](https://github.com/r-spatial/leafgl/issues/54) & [#60](https://github.com/r-spatial/leafgl/issues/60)
* expose additional JavaScript arguments in addGlPoints via magic dots. #54 & #60

## leafgl 0.1.1

Expand Down
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
45 changes: 21 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,19 @@

# leafgl - performant WebGL rendering for leaflet

<!-- badges: start -->
[![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)
<!-- badges: end -->

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
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

Expand Down Expand Up @@ -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
Expand All @@ -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

Expand Down Expand Up @@ -118,12 +115,12 @@ leaflet() %>%

<br>

-----
------------------------------------------------------------------------

#### 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)
Expand Down Expand Up @@ -151,7 +148,7 @@ leaflet() %>%

<br>

-----
------------------------------------------------------------------------

#### 100k polygons on a map

Expand Down Expand Up @@ -188,11 +185,11 @@ leaflet() %>%

<br>

-----
------------------------------------------------------------------------

## Shiny

Thanks to \[@ColinFay\](<https://github.com/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:
Expand Down Expand Up @@ -232,7 +229,7 @@ shinyApp(ui, server)

<br>

-----
------------------------------------------------------------------------

## Contact

Expand Down
4 changes: 4 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
url: https://r-spatial.github.io/leafgl/
template:
bootstrap: 5

1 change: 1 addition & 0 deletions leafgl.Rproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Version: 1.0
ProjectId: 86101ef8-f6ce-44c2-8cd5-8815a22f7175

RestoreWorkspace: Default
SaveWorkspace: Default
Expand Down

0 comments on commit f978f87

Please sign in to comment.