<commit_before>ggThemeAssist
==============
[![Build Status](https://travis-ci.org/calligross/ggthemeassist.svg?branch=master)](https://travis-ci.org/calligross/ggthemeassist)
[![CRAN](http://www.r-pkg.org/badges/version/ggThemeAssist)](http://cran.rstudio.com/package=ggThemeAssist) [![Downloads](http://cranlogs.r-pkg.org/badges/ggThemeAssist?color=brightgreen)](http://www.r-pkg.org/pkg/ggThemeAssist)


**ggThemeAssist** is a RStudio-Addin that uses the [`rstudioapi`](https://github.com/rstudio/rstudioapi) package and provides a GUI for editing [`ggplot2`](https://github.com/hadley/ggplot2) themes. 

For a full list of features see [`NEWS`](./NEWS.md).

User interface issues
------------

There are two known problems with the UI which easily can be fixed:

1. On linux and windows, please ensure that you've installed at least shiny version 0.13.1.
1. We realized shorty after the cran release that there is an issue with smaller screens. Some users may expirience an unapropiate sized plot. This issue has been fixed in version 0.1.1, which can be installed from github (please see below).



Installation
------------

Please be aware that you need the **most recent (stable) release of RStudio** (v0.99.878 or later). Additionally, **ggThemeAssist** depends on [`shiny`](https://github.com/rstudio/shiny) and [`miniUI`](https://github.com/rstudio/miniUI).

#### Install from Github
You can install the latest version of **ggThemeAssist** from Github using the [`devtools`](https://github.com/hadley/devtools) package:
```r
if (!requireNamespace("devtools", quietly = TRUE))
  install.packages("devtools")

devtools::install_github("calligross/ggthemeassist")
```

#### Install from CRAN

The first stable version of **ggThemeAssist**, v0.1.0, is now available on CRAN:
```r
install.packages("ggThemeAssist")
```
We advise users to install from github. Due to CRAN policies and the rapid development of ggThemeAssist, many new features and bugfixes will be available on CRAN several weeks later.

Usage
------------
After installing, **ggThemeAssist** is available in the Addins menu within RStudio.

To edit `ggplot2` themes, just highlight a `ggplot2` object in your current script and run the Addin from the Addins menu. **ggplot2** will analyze your current plot, update its defaults to your current specification and give you a preview. Use the input widgets to get your ideas into shape. After terminating **ggThemeAssist** a character string containing your desired changes in standard `ggplot2` notation is inserted in your script. Re-running your script now produces the plot you just configured using **ggThemeAssist**.

<center>[**Click to enlarge**](https://raw.githubusercontent.com/calligross/ggthemeassist/master/examples/ggThemeAssist2.gif)<center>
![Screenshot](examples/ggThemeAssist2.gif)
<commit_msg>Updated the readme<commit_after>ggThemeAssist
==============
[![Build Status](https://travis-ci.org/calligross/ggthemeassist.svg?branch=master)](https://travis-ci.org/calligross/ggthemeassist)
[![CRAN](http://www.r-pkg.org/badges/version/ggThemeAssist)](http://cran.rstudio.com/package=ggThemeAssist) [![Downloads](http://cranlogs.r-pkg.org/badges/ggThemeAssist?color=brightgreen)](http://www.r-pkg.org/pkg/ggThemeAssist)


**ggThemeAssist** is a RStudio-Addin that uses the [`rstudioapi`](https://github.com/rstudio/rstudioapi) package and provides a GUI for editing [`ggplot2`](https://github.com/hadley/ggplot2) themes. 

For a full list of features see [`NEWS`](./NEWS.md).


Installation
------------

Please be aware that you need the **most recent (stable) release of RStudio** (v0.99.878 or later). Additionally, **ggThemeAssist** depends on [`shiny`](https://github.com/rstudio/shiny) and [`miniUI`](https://github.com/rstudio/miniUI).

#### Install from Github
You can install the latest version of **ggThemeAssist** from Github using the [`devtools`](https://github.com/hadley/devtools) package:
```r
if (!requireNamespace("devtools", quietly = TRUE))
  install.packages("devtools")

devtools::install_github("calligross/ggthemeassist")
```

#### Install from CRAN

The stable version of **ggThemeAssist**, v0.1.4, is available on CRAN:
```r
install.packages("ggThemeAssist")
```
<!---

We advise users to install from github. Due to CRAN policies and the rapid development of ggThemeAssist, many new features and bugfixes may be available on CRAN several weeks later.
-->

Usage
------------
After installing, **ggThemeAssist** is available in the Addins menu within RStudio.

To edit `ggplot2` themes, just highlight a `ggplot2` object in your current script and run the Addin from the Addins menu. **ggplot2** will analyze your current plot, update its defaults to your current specification and give you a preview. Use the input widgets to get your ideas into shape. After terminating **ggThemeAssist** a character string containing your desired changes in standard `ggplot2` notation is inserted in your script. Re-running your script now produces the plot you just configured using **ggThemeAssist**.

<center>[**Click to enlarge**](https://raw.githubusercontent.com/calligross/ggthemeassist/master/examples/ggThemeAssist2.gif)<center>
![Screenshot](examples/ggThemeAssist2.gif)

{'fraction_non_alphanumeric': 0.13580719204284622, 'fraction_numerical': 0.008224942616679418, 'mean_word_length': 5.16627358490566, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 16, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1132968', 'n_tokens_mistral': 1609, 'n_tokens_neox': 1539, 'n_words': 514}