updated readme

.Rbuildignore

@@ -12,3 +12,4 @@ img/
 ^\.github$
 revdep/
 ^CRAN-SUBMISSION$
+^README\.Rmd$

README.Rmd

@@ -0,0 +1,108 @@
+---
+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%"
+)
+```
+
+# esquisse <img src="man/figures/logo.png" width=200 align="right" />
+
+> The purpose of this add-in is to let you explore your data quickly to extract the information they hold. You can create visualization with [{ggplot2}](https://ggplot2.tidyverse.org/), filter data with [{dplyr}](https://dplyr.tidyverse.org/) and retrieve generated code.
+
+<!-- badges: start -->
+[![version](http://www.r-pkg.org/badges/version/esquisse)](https://CRAN.R-project.org/package=esquisse)
+[![cranlogs](http://cranlogs.r-pkg.org/badges/esquisse)](https://CRAN.R-project.org/package=esquisse)
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
+[![R-CMD-check](https://github.com/dreamRs/esquisse/workflows/R-CMD-check/badge.svg)](https://github.com/dreamRs/esquisse/actions)
+<!-- badges: end -->
+
+This addin allows you to interactively explore your data by visualizing it with the [ggplot2](https://github.com/tidyverse/ggplot2) package. It allows you to draw bar plots, curves, scatter plots, histograms, boxplot and [sf](https://github.com/r-spatial/sf) objects, then export the graph or retrieve the code to reproduce the graph.
+
+See online documentation : https://dreamrs.github.io/esquisse/index.html
+
+If you find bugs, please open an [issue](https://github.com/dreamRs/esquisse/issues)
+
+
+## Installation
+
+Install from [CRAN](https://CRAN.R-project.org/package=esquisse) with :
+
+```r
+install.packages("esquisse")
+```
+
+Or install development version from [GitHub](https://github.com/dreamRs/esquisse) :
+
+```r
+remotes::install_github("dreamRs/esquisse")
+```
+
+Then launch the addin via the RStudio menu or with `esquisse::esquisser()`.
+
+
+## esquisse addin
+
+```r
+esquisse::esquisser()
+# or with your data:
+esquisse::esquisser(palmerpenguins::penguins)
+```
+
+![](man/figures/esquisse.gif)
+
+Above gif was made with :heart: by [@mfanny](https://github.com/mfanny) and cannot be removed, but in the meantime {esquisse} has evolved, the latest version now looks like:
+
+![](man/figures/esquisse.png)
+
+
+### Internationalization
+
+```{r, include=FALSE}
+i18n_flag <- function(code, language) {
+  code <- strsplit(code, split = "|", fixed = TRUE)[[1]]
+  flag <- sprintf("<img src=\"man/figures/i18n/%s.svg\" height=\"16\" style=\"height:16px\"/>", code)
+  paste(paste(flag, collapse = ""), language)
+}
+i18n_flags <- function(languages) {
+  mapply(
+    FUN = i18n_flag, 
+    code = names(languages),
+    language = unlist(languages, use.names = FALSE),
+    USE.NAMES = FALSE
+  )
+}
+languages <- list(
+  gb = "english (default)",
+  fr = "french",
+  mk = "macedonian",
+  "br|pt" = "brazilian portuguese",
+  al = "albanian",
+  cn = "chinese",
+  es = "spanish",
+  # de = "german",
+  tr = "turkish",
+  kr = "korean"
+)
+```
+
+
+Currently you can use {datamods} in the following language: `r i18n_flags(languages)`.
+
+```r
+library(esquisse)
+set_i18n("fr")
+esquisser()
+```
+
+If you want another language to be supported, you can submit a Pull Request to add a CSV file like the one used for french (file is located in `inst/i18n` folder in the package, you can see it [here on GitHub](https://github.com/dreamRs/esquisse/blob/master/inst/i18n/fr.csv)).
+
+See [{datamods} vignette](https://dreamrs.github.io/datamods/articles/i18n.html) for more on this topic.
+

README.md

@@ -1,64 +1,101 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
 # esquisse <img src="man/figures/logo.png" width=200 align="right" />
 
-> The purpose of this add-in is to let you explore your data quickly to extract the information they hold. You can create visualization with [{ggplot2}](https://ggplot2.tidyverse.org/), filter data with [{dplyr}](https://dplyr.tidyverse.org/) and retrieve generated code.
+> The purpose of this add-in is to let you explore your data quickly to
+> extract the information they hold. You can create visualization with
+> [{ggplot2}](https://ggplot2.tidyverse.org/), filter data with
+> [{dplyr}](https://dplyr.tidyverse.org/) and retrieve generated code.
 
 <!-- badges: start -->
+
 [![version](http://www.r-pkg.org/badges/version/esquisse)](https://CRAN.R-project.org/package=esquisse)
 [![cranlogs](http://cranlogs.r-pkg.org/badges/esquisse)](https://CRAN.R-project.org/package=esquisse)
-[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
+[![Lifecycle:
+stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html)
 [![R-CMD-check](https://github.com/dreamRs/esquisse/workflows/R-CMD-check/badge.svg)](https://github.com/dreamRs/esquisse/actions)
 <!-- badges: end -->
 
-This addin allows you to interactively explore your data by visualizing it with the [ggplot2](https://github.com/tidyverse/ggplot2) package. It allows you to draw bar plots, curves, scatter plots, histograms, boxplot and [sf](https://github.com/r-spatial/sf) objects, then export the graph or retrieve the code to reproduce the graph.
-
-See online documentation : https://dreamrs.github.io/esquisse/index.html
+This addin allows you to interactively explore your data by visualizing
+it with the [ggplot2](https://github.com/tidyverse/ggplot2) package. It
+allows you to draw bar plots, curves, scatter plots, histograms, boxplot
+and [sf](https://github.com/r-spatial/sf) objects, then export the graph
+or retrieve the code to reproduce the graph.
 
-If you find bugs, please open an [issue](https://github.com/dreamRs/esquisse/issues)
+See online documentation :
+<https://dreamrs.github.io/esquisse/index.html>
 
+If you find bugs, please open an
+[issue](https://github.com/dreamRs/esquisse/issues)
 
 ## Installation
 
 Install from [CRAN](https://CRAN.R-project.org/package=esquisse) with :
 
-```r
+``` r
 install.packages("esquisse")
 ```
 
-Or install development version from [GitHub](https://github.com/dreamRs/esquisse) :
+Or install development version from
+[GitHub](https://github.com/dreamRs/esquisse) :
 
-```r
+``` r
 remotes::install_github("dreamRs/esquisse")
 ```
 
-Then launch the addin via the RStudio menu or with `esquisse::esquisser()`.
-
+Then launch the addin via the RStudio menu or with
+`esquisse::esquisser()`.
 
 ## esquisse addin
 
-```r
+``` r
 esquisse::esquisser()
 # or with your data:
 esquisse::esquisser(palmerpenguins::penguins)
 ```
 
 ![](man/figures/esquisse.gif)
 
-Above gif was made with :heart: by [@mfanny](https://github.com/mfanny) and cannot be removed, but in the meantime {esquisse} has evolved, the latest version now looks like:
+Above gif was made with :heart: by [@mfanny](https://github.com/mfanny)
+and cannot be removed, but in the meantime {esquisse} has evolved, the
+latest version now looks like:
 
 ![](man/figures/esquisse.png)
 
-
 ### Internationalization
 
-Currently you can use {esquisse} in the following language: <img src="man/figures/i18n/gb.svg" height="16" style="height:16px"/> english (default), <img src="man/figures/i18n/fr.svg" height="16" style="height:16px"/> french (`"fr"`), <img src="man/figures/i18n/mk.svg" height="16" style="height:16px"/> macedonian (`"mk"`), <img src="man/figures/i18n/al.svg" height="16" style="height:16px"/> albanian (`"al"`). Activate with:
-
-```r
+Currently you can use {datamods} in the following language:
+<img src="man/figures/i18n/gb.svg" height="16" style="height:16px"/>
+english (default),
+<img src="man/figures/i18n/fr.svg" height="16" style="height:16px"/>
+french,
+<img src="man/figures/i18n/mk.svg" height="16" style="height:16px"/>
+macedonian,
+<img src="man/figures/i18n/br.svg" height="16" style="height:16px"/><img src="man/figures/i18n/pt.svg" height="16" style="height:16px"/>
+brazilian portuguese,
+<img src="man/figures/i18n/al.svg" height="16" style="height:16px"/>
+albanian,
+<img src="man/figures/i18n/cn.svg" height="16" style="height:16px"/>
+chinese,
+<img src="man/figures/i18n/es.svg" height="16" style="height:16px"/>
+spanish,
+<img src="man/figures/i18n/tr.svg" height="16" style="height:16px"/>
+turkish,
+<img src="man/figures/i18n/kr.svg" height="16" style="height:16px"/>
+korean.
+
+``` r
 library(esquisse)
 set_i18n("fr")
 esquisser()
 ```
 
-If you want another language to be supported, you can submit a Pull Request to add a CSV file like the one used for french (file is located in `inst/i18n` folder in the package, you can see it [here on GitHub](https://github.com/dreamRs/esquisse/blob/master/inst/i18n/fr.csv)).
-
-See [{datamods} vignette](https://dreamrs.github.io/datamods/articles/i18n.html) for more on this topic.
+If you want another language to be supported, you can submit a Pull
+Request to add a CSV file like the one used for french (file is located
+in `inst/i18n` folder in the package, you can see it [here on
+GitHub](https://github.com/dreamRs/esquisse/blob/master/inst/i18n/fr.csv)).
 
+See [{datamods}
+vignette](https://dreamrs.github.io/datamods/articles/i18n.html) for
+more on this topic.