The pmtiles package provides a simple interface to create PMTiles
using the Tippecanoe command-line tool. PMTiles is a file format for
efficiently storing map tiles as a single file.
You can install the development version of pmtiles from GitHub with:
# install.packages("devtools")
devtools::install_github("nptscot/pmtiles")This package requires Tippecanoe to be installed on your system. Please follow the installation instructions on the Tippecanoe GitHub page.
You can check if Tippecanoe is installed and get its version:
library(pmtiles)Alternatively, you can load the package with the following for local development:
devtools::load_all()# Check if Tippecanoe is installed
is_tippecanoe_installed()The simplest way to create PMTiles is to use the pmtiles() function:
library(pmtiles)
# Create PMTiles from a GeoJSON file
pmtiles("your_file.geojson")This will create a PMTiles file in the ./pmtiles directory with
sensible defaults.
The package includes an example dataset for Edinburgh:
# Load the dataset
data(edinburgh_centre)
# Check the structure
class(edinburgh_centre)
#> [1] "sf" "data.frame"
# See the first few features
head(edinburgh_centre[, 1:2])
#> osm_id highway
#> 4 2429890 tertiary
#> 5 2429892 tertiary
#> 18 2954058 tertiary
#> 24 2956310 tertiary
#> 25 2956311 tertiary
#> 26 2956313 tertiaryTo create PMTiles from this dataset:
# Create a temporary GeoJSON file
temp_geojson = tempfile(fileext = ".geojson")
sf::st_write(edinburgh_centre, temp_geojson, delete_dsn = TRUE)
# Create PMTiles
pmtiles(
input_file = temp_geojson,
output_name = "edinburgh_example",
attribution = "City of Edinburgh | pmtiles R package"
)For more control over the PMTiles creation process, use the
create_pmtiles() function:
library(pmtiles)
# Create PMTiles with custom parameters
create_pmtiles(
input_file = "path/to/your/data.geojson",
output_folder = "output/directory",
output_name = "my_tiles",
layer_name = "my_layer",
attribution = "My Organization",
min_zoom = 6,
max_zoom = 13,
drop_smallest = TRUE,
max_tile_bytes = 2000000,
buffer = 5,
simplification = 10,
force = TRUE
)
# Order features by a specific variable
create_pmtiles(
input_file = "path/to/your/data.geojson",
output_folder = "output/directory",
output_name = "my_tiles",
order_by = "all_fastest_bicycle_go_dutch"
)This project is licensed under the MIT License.