

<!-- README.md is generated from README.qmd. Please edit that file -->

# layer <a><img src='man/figures/logo.svg' align="right" height=210 width=182/></a>

<!-- badges: start -->

[![Project Status:
Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
<a href="https://lifecycle.r-lib.org/articles/stages.html#stable"
target="_blank"><img
src="https://img.shields.io/badge/lifecycle-stable-brightgreen.svg"
alt="Lifecycle: stable" /></a>
<a href="https://CRAN.R-project.org/package=layer" target="_blank"><img
src="https://www.r-pkg.org/badges/version/layer"
alt="CRAN status" /></a>
<a href="https://CRAN.R-project.org/package=layer" target="_blank"><img
src="https://cranlogs.r-pkg.org/badges/grand-total/layer?color=blue"
alt="CRAN/METACRAN Total downloads" /></a>
<a href="https://CRAN.R-project.org/package=layer" target="_blank"><img
src="https://cranlogs.r-pkg.org/badges/layer?color=blue"
alt="CRAN/METACRAN Downloads per month" /></a>
[![R-CMD-check](https://github.com/marcosci/layer/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/marcosci/layer/actions/workflows/R-CMD-check.yaml)

[![DOI](https://zenodo.org/badge/DOI/10.32614/CRAN.package.layer.svg)](https://doi.org/10.32614/CRAN.package.layer)

<!-- badges: end -->

The goal of `layer` is to simplify the whole process of creating stacked
tilted maps, that are often used in scientific publications to show
different environmental layers for a geographical region. Tilting maps
and layering them allows to easily draw visual correlations between
these environmental layers.

Something in the line of:

<img src="man/figures/example.jpg"
data-fig-alt="Example of a stacked tilted map by Cédric Scherer and Marco Sciaini" />

## Installation

You can install the development version of layer from
[GitHub](https://github.com/) with:

``` r
# install.packages("remotes")
remotes::install_github("marcosci/layer")
```

## Example

This is a basic example which shows you how to solve a common problem:

``` r
library(layer)

tilt_landscape_1 <- tilt_map(landscape_1)
tilt_landscape_2 <- tilt_map(landscape_2, x_shift = 25, y_shift = 50)
tilt_landscape_3 <- tilt_map(landscape_3, x_shift = 50, y_shift = 100)
tilt_landscape_points <- tilt_map(landscape_points, x_shift = 75, y_shift = 150)

map_list <- list(tilt_landscape_1, tilt_landscape_2, tilt_landscape_3, tilt_landscape_points)

plot_tiltedmaps(map_list,
                layer = c("value", "value", "value", NA),
                palette = c("bilbao", "mako", "rocket", NA),
                color = "grey40")
```

<img src="man/figures/README-example-1.png"
data-fig-alt="Basic example of a stacked tilted map" width="672" />

### More advanced example

Some more realistic looking data (DEM, drought, precipitation, and
wildfires for continental USA):

``` r
tilt_landscape_1 <- tilt_map(dem_usa, y_tilt = 3)
tilt_landscape_2 <- tilt_map(drought_usa, y_tilt = 3, x_shift = 15, y_shift = 25)
tilt_landscape_3 <- tilt_map(prec_usa, y_tilt = 3, x_shift = 30, y_shift = 50)
tilt_landscape_4 <- tilt_map(fire_usa, y_tilt = 3, x_shift = 45, y_shift = 65)

map_list <- list(tilt_landscape_1, tilt_landscape_2, tilt_landscape_3, tilt_landscape_4)

plot_tiltedmaps(map_list, palette = c("tofino", "rocket", "mako", "magma"), direction = c(-1, 1, 1, 1))
```

<img src="man/figures/README-adv-example.png"
data-fig-alt="Advanced example of a stacked tilted map" />

## Code of Conduct

Please note that the `layer` project is released with a [Contributor
Code of
Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
