riatelab/bertinr

A wrapper for bertin.js

bertin

bertin.js is an easy to use JavaScript library mainly based on D3.js makes creating thematic maps simple. The principle is to work with layers stacked on top of one other. Much like in Geographic Information Software (GIS) software, bertin.js displays layers with a specific hierarchy. The layer at bottom are rendered and then followed by the layer right above it. Some of the layers are used to display various components of a map, some of common layers are: header, footer, graticule, outline, choro, typo, prop, shadow, scalebar, text etc.

bertin package is a wrapper around bertin.js

Installation

You can install the development version of bertin from GitHub with:

# install.packages("remotes")
remotes::install_github("riatelab/bertin")

Example

library(bertin)
library(sf)
world <- st_read(system.file("gpkg/world.gpkg", package = "bertin"),
                 layer = "world", quiet = TRUE)
bt_param(width = 800)|>
  bt_layer(data = world, fill = "#808080") |>
  bt_bubble(data = world, values = "pop", k = 20) |>
  bt_draw() |> 
  bt_save("map.svg")

file: “map.svg”

See examples here

bertinr's Issues

Vignettes

A vignette by usage
Off-CRAN vignettes?

How to export as an svg file?

We should produce a shiny example

move the repo from private to open?

It would allow to use github pages

bt_logo | Local images are not rendered

bt_logo works correctly with a url

library(bertin)
library(sf)

bt_logo <-function(bertin, url, position, size = 100, display= TRUE){
  res <- c(as.list(environment()))
  res <- bertin:::clean_input(res, type = "logo")
  if(missing(bertin)){bertin <- list()}
  bertin$layers[[length(bertin$layers) + 1]] <- res
  return(bertin)
}

world <- st_read(system.file("gpkg/world.gpkg", package = "bertin"),
                 layer = "world", quiet = TRUE)
img <- "https://upload.wikimedia.org/wikipedia/commons/thumb/1/1b/R_logo.svg/310px-R_logo.svg.png"

bt_param(margin = 10, width = 500, projection = "Winkel3") |>
  bt_layer(data = world, fill = "red") |>
  bt_logo(url = img) |>
  bt_draw()

^{Created on 2023-05-11 with reprex v2.0.2}

But if I do the same with a local image that doesn't work, i also tried with file:// on the path

library(bertin)
library(sf)

bt_logo <-function(bertin, url, position, size = 100, display= TRUE){
  res <- c(as.list(environment()))
  res <- bertin:::clean_input(res, type = "logo")
  if(missing(bertin)){bertin <- list()}
  bertin$layers[[length(bertin$layers) + 1]] <- res
  return(bertin)
}

world <- st_read(system.file("gpkg/world.gpkg", package = "bertin"),
                 layer = "world", quiet = TRUE)
img <- paste0("file://",system.file("png/bertin.png", package = "bertin"))

bt_param(margin = 10, width = 500, projection = "Winkel3") |>
  bt_layer(data = world, fill = "red") |>
  bt_logo(url = img) |>
  bt_draw()

^{Created on 2023-05-11 with reprex v2.0.2}

bt_waterlines is not working

Shouldn't we rename it bertin instead of bertinR?