README.Rmd

---
output: github_document
---

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

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  eval = FALSE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# plainview - Interactively Explore (Raster)Images

<!-- badges: start -->
[![R-CMD-check](https://github.com/r-spatial/plainview/workflows/R-CMD-check/badge.svg)](https://github.com/r-spatial/plainview/actions)
![monthly](http://cranlogs.r-pkg.org/badges/plainview)
![total](http://cranlogs.r-pkg.org/badges/grand-total/plainview)
[![CRAN](http://www.r-pkg.org/badges/version/plainview?color=009999)](https://cran.r-project.org/package=plainview)
[![status](https://tinyverse.netlify.com/badge/plainview)](https://CRAN.R-project.org/package=plainview)
<!-- badges: end -->

`plainview` enables interactive exploration of (raster)images. Images will be 
rendered on a plain HTML canvas (hence the name of the package). For spatial data
this means that rendering is not restricted to a certain projection (e.g. web
mercator for leaflet or mapview) but rendering is projection independent. It also 
means that it is possible to plot large images made up of millions of pixels.
  
## Installation

You can install the released version of `plainview` from [CRAN](https://CRAN.R-project.org) with:

```{r, eval=FALSE}
install.packages("plainview")
```

## Example

```{r layer, eval=FALSE}
# RasterLayer
plainView(poppendorf[[4]])
```

![](man/figures/README-layer.png)

```{r stack true, eval=FALSE}
# RasterStack
plainview(poppendorf, r = 4, g = 3, b = 2) # true color
```

![](man/figures/README-stack_true.png)

```{r stack false, eval=FALSE}
plainview(poppendorf, r = 5, g = 4, b = 3) # false color
```

![](man/figures/README-stack_false.png)

### Code of Conduct

Please note that the 'plainview' project is released with a [Contributor Code of Conduct](https://github.com/r-spatial/plainview/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.