diff --git a/README.Rmd b/README.Rmd index 36a8106..52638b5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -11,14 +11,17 @@ knitr::opts_chunk$set( fig.path = "man/figures/README-", out.width = "100%" ) + +desc = read.dcf('DESCRIPTION') +desc = setNames(as.list(desc), colnames(desc)) ``` -# visualizeR - - +# `r desc$Package` -The goal of visualizeR is to propose some utils to get REACH and AGORA colors, ready-to-go color palettes, and a few visualization functions (horizontal hist graph for instance). +> `r desc$Title` + +`visualizeR` proposes some utils to get REACH and AGORA colors, ready-to-go color palettes, and a few visualization functions (horizontal hist graph for instance). ## Installation diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1cc152 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ + + + +# visualizeR + +> What a color! What a viz! + +`visualizeR` proposes some utils to get REACH and AGORA colors, +ready-to-go color palettes, and a few visualization functions +(horizontal hist graph for instance). + +## Installation + +You can install the last version of visualizeR from +[GitHub](https://github.com/) with: + +``` r +# install.packages("devtools") +devtools::install_github("gnoblet/visualizeR", build_vignettes = TRUE) +``` + +## Roadmap + +Roadmap is as follows: + +- [ ] Add IMPACT’s colors +- [ ] Add all color palettes from the internal documentation +- [ ] Add new types of visualization (e.g. dumbbell plot) +- [ ] Use examples +- [ ] Add some ease-map functions +- [ ] Add some interactive functions (maps and graphs) + +## Request + +Please, do not hesitate to pull request any new viz or colors or color +palettes, or to email request any change +( or ). + +## Example + +``` r +library(visualizeR) +# Get all saved REACH colors, named +cols_reach(unnamed = F) +``` diff --git a/man/figures/logo.png b/man/figures/logo.png new file mode 100644 index 0000000..145688b Binary files /dev/null and b/man/figures/logo.png differ