-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathREADME.Rmd
71 lines (48 loc) · 4.28 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE, comment = "#>", fig.path = "man/figures/README-",
message = FALSE, warning = FALSE, error = FALSE
)
```
# tiler <img src="man/figures/logo.png" style="margin-left:10px;margin-bottom:5px;" width="120" align="right">
<!-- badges: start -->
[](https://www.repostatus.org/)
[](https://github.com/ropensci/tiler/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/ropensci/tiler?branch=master)
[](https://github.com/ropensci/software-review/issues/226)
[](https://cran.r-project.org/package=tiler)
[](https://cran.r-project.org/package=tiler)
[](https://github.com/ropensci/tiler)
<!-- badges: end -->
## Create geographic and non-geographic map tiles
The `tiler` package provides a tile generator function for creating map tile sets for use with packages such as `leaflet`. In addition to generating map tiles based on a common raster layer source, it also handles the non-geographic edge case, producing map tiles from arbitrary images. These map tiles, which have a a non-geographic simple coordinate reference system, can also be used with `leaflet` when applying the simple CRS option.
Map tiles can be created from an input file with any of the following extensions: `tif`, `grd` and `nc` for spatial maps and `png`, `jpg` and `bmp` for basic images.
## Motivation
This package helps R users who wish to create geographic and non-geographic map tiles easily and seamlessly with only a single line of R code. The intent is to do this with a package that has
* minimal heavy package dependencies.
* minimal extraneous general features and functions that do not have to do with tile generation.
* to create tiles without having to code directly in other software, interact directly with Python, or make calls at the command line; allowing the R user to remain comfortably within the familiar R environment.
* to support the creation on map tiles from raw images for users who wish to create non-standard maps, which may also be followed by georeferencing locations of interest in the simplified coordinate reference system of the map image.
## Installation
Install `tiler` from CRAN with
``` r
install.packages("tiler")
```
Install the development version from GitHub with
``` r
# install.packages("remotes")
remotes::install_github("ropensci/tiler")
```
For non-geographic tiles, using a `png` file is recommended for quality and file size. `jpg` may yield a lower quality result, while a large, high resolution `bmp` file may have an enormous file size compared to `png`.
`jpg` and `bmp` are optionally supported by `tiler`. This means they are not installed and imported with `tiler`. It is assumed the user will provide `png` images. If using `jpg` or `bmp` and the packages `jpeg` or `bmp` are not installed, respectively, `tile()` will print a message to the console notifying of the required package installations.
### System requirements
This package requires Python and the `gdal` library for Python.
Windows users are recommended to install [OSGeo4W](https://trac.osgeo.org/osgeo4w/) as an easy way to obtain the required `gdal` support for Python in Windows. See `tiler_options()` or the package vignette for more information.
---
Please note that the `tiler` project is released with a [Contributor Code of Conduct](https://github.com/ropensci/tiler/blob/master/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
[](https://ropensci.org)