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

------------------------------------------------------------------------

<!-- badges: start -->

[![R-CMD-check](https://github.com/mdsumner/ggpolypath/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mdsumner/ggpolypath/actions/workflows/R-CMD-check.yaml)
[![CRAN
status](https://www.r-pkg.org/badges/version/ggpolypath)](https://CRAN.R-project.org/package=ggpolypath)
<!-- badges: end -->

## ggpolypath

A `ggplot2` geom for polygons with holes, called ‘geom_polypath’.

PLEASE NOTE: ggpolypath predates full support for polygonal path
geoemtry in ggplot2, we advise use of the ggplot2 package directly
rather than this package, please see
<https://www.tidyverse.org/blog/2019/06/ggplot2-3-2-0/>.

## Install

Install from CRAN.

``` r
install.packages("ggpolypath")
```

Install the development version.

``` r
## install from Github
devtools::install_github("mdsumner/ggpolypath")
```

## Example

See the vignette for examples.

``` r
vignette("ggpolypath")
```

## Gory details

More examples, and more detail than you probably need can be found here:

<https://github.com/hypertidy/polyggon/blob/master/README.md>
