-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
64 lines (48 loc) · 2.18 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# nivor
<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/nivor)](https://CRAN.R-project.org/package=nivor)
[![Codecov test coverage](https://codecov.io/gh/swsoyee/nivor/branch/main/graph/badge.svg)](https://codecov.io/gh/swsoyee/nivor?branch=main)
[![R-CMD-check](https://github.com/swsoyee/nivor/workflows/R-CMD-check/badge.svg)](https://github.com/swsoyee/nivor/actions)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
<!-- badges: end -->
The goal of nivor is to ...
## Installation
~~You can install the released version of nivor from [CRAN](https://CRAN.R-project.org)~~ with:
``` r
# Give me more time to make the first release!
# install.packages("nivor")
```
And the development version from [GitHub](https://github.com/swsoyee/nivor) with:
```r
# install.packages("devtools")
devtools::install_github("swsoyee/nivor")
```
## Example
This is a basic example which shows you how to solve a common problem:
```{r load, eval=FALSE}
library(nivor)
```
### Gallery
| AreaBump | Bump | Calendar |
| -------- | ---- | -------- |
| ![AreaBump](man/figures/AreaBump.png) | ![Bump](man/figures/Bump.png) | ![Calendar](man/figures/Calendar_Multiple.png) |
| **Chord** | **Line** | **Pie** |
| ![Chord](man/figures/Chord.png) | ![Line](man/figures/Line.png) | ![Pie](man/figures/Pie.png) |
| **Parallel Coordinates** | **(WIP)** | **Stream** |
| ![Parallel Coordinates](man/figures/ParallelCoordinates.png) | | ![Stream](man/figures/Stream.png) |
| **ScatterPlot** | **Voronoi** | **Waffle** |
| ![ScatterPlot](man/figures/Scatter.png) | ![Voronoi](man/figures/Voronoi.png) | ![Waffle](man/figures/Waffle.png) |
## Code of Conduct
Please note that the nivor 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.