Add logo and update readme

This commit is contained in:
gnoblet 2022-05-01 11:54:59 +02:00
parent 9c569b86bb
commit c84c8f01a3
3 changed files with 52 additions and 4 deletions

View file

@ -11,14 +11,17 @@ knitr::opts_chunk$set(
fig.path = "man/figures/README-", fig.path = "man/figures/README-",
out.width = "100%" out.width = "100%"
) )
desc = read.dcf('DESCRIPTION')
desc = setNames(as.list(desc), colnames(desc))
``` ```
# visualizeR
<!-- badges: start --> # `r desc$Package` <img src="man/figures/logo.png" align="right" alt="" width="120"/>
<!-- badges: end -->
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 ## Installation

45
README.md Normal file
View file

@ -0,0 +1,45 @@
<!-- README.md is generated from README.Rmd. Please edit that file -->
# visualizeR <img src="man/figures/logo.png" align="right" alt="" width="120"/>
> 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 IMPACTs 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
(<guillaume.noblet@reach-initiative.org> or <gnoblet@zaclys.net>).
## Example
``` r
library(visualizeR)
# Get all saved REACH colors, named
cols_reach(unnamed = F)
```

BIN
man/figures/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB