Skip to content

Commit

Permalink
Update more installation messaging
Browse files Browse the repository at this point in the history
  • Loading branch information
cpsievert committed Jan 20, 2021
1 parent 2bec680 commit 39d6a8a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
11 changes: 5 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,19 @@ Simplified theming of **ggplot2**, **lattice**, and **base** R graphics. In addi

## Installation

**thematic** is not yet available on [CRAN](https://CRAN.R-project.org), but you can install it now with:
Install the stable release of **thematic** on [CRAN](https://CRAN.R-project.org) with:

``` r
remotes::install_github("rstudio/thematic")
library(thematic)
install.packages("thematic")
```

For [auto theming in Shiny](https://rstudio.github.io/thematic/articles/auto.html#shiny), you'll need **shiny** v.1.5.0 or higher.
[Auto theming in Shiny](https://rstudio.github.io/thematic/articles/auto.html#shiny) requires **shiny** 1.5.0 or higher, which is also available on CRAN:

```r
install.packages("shiny")
```

For [auto theming in R Markdown](https://rstudio.github.io/thematic/articles/auto.html#rmd), you'll currently need the development version of **rmarkdown**:
[Auto theming in R Markdown](https://rstudio.github.io/thematic/articles/auto.html#rmd) requires **rmarkdown** 2.6.6 or higher, which currently isn't on CRAN (but is available on GitHub):

```r
remotes::install_github("rstudio/rmarkdown")
Expand Down Expand Up @@ -101,7 +100,7 @@ knitr::include_graphics("man/figures/auto-before.png")
To add automatic coloring _and fonts_ (i.e., the full auto theming experience) to the R plots, simply call `thematic_on(font = "auto")` and re-run the application. Since the plots are generated via Shiny, they assume new defaults which are informed by the CSS styling on their HTML container (that is, notice how the R plots now reflect the styling of the `shiny::tabsetPanel()`). Moreover, as long as the relevant font is a [Google Font](https://fonts.google.com) (in this case, [Pacifico](https://fonts.google.com/specimen/Pacifico)), **thematic** automatically downloads, caches, and registers font(s) with R.

```r
thematic_shiny(font = "auto")
thematic::thematic_shiny(font = "auto")
shinyApp(ui, server)
```

Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,25 @@ plots in Shiny, R Markdown, and RStudio.

## Installation

**thematic** is not yet available on [CRAN](https://CRAN.R-project.org),
but you can install it now with:
Install the stable release of **thematic** on
[CRAN](https://CRAN.R-project.org) with:

``` r
remotes::install_github("rstudio/thematic")
library(thematic)
install.packages("thematic")
```

For [auto theming in
Shiny](https://rstudio.github.io/thematic/articles/auto.html#shiny),
you’ll need **shiny** v.1.5.0 or higher.
[Auto theming in
Shiny](https://rstudio.github.io/thematic/articles/auto.html#shiny)
requires **shiny** 1.5.0 or higher, which is also available on CRAN:

``` r
install.packages("shiny")
```

For [auto theming in R
Markdown](https://rstudio.github.io/thematic/articles/auto.html#rmd),
you’ll currently need the development version of **rmarkdown**:
[Auto theming in R
Markdown](https://rstudio.github.io/thematic/articles/auto.html#rmd)
requires **rmarkdown** 2.6.6 or higher, which currently isn’t on CRAN
(but is available on GitHub):

``` r
remotes::install_github("rstudio/rmarkdown")
Expand Down Expand Up @@ -109,7 +109,7 @@ the `shiny::tabsetPanel()`). Moreover, as long as the relevant font is a
automatically downloads, caches, and registers font(s) with R.

``` r
thematic_shiny(font = "auto")
thematic::thematic_shiny(font = "auto")
shinyApp(ui, server)
```

Expand Down
Binary file modified man/figures/README-ggrepel-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 39d6a8a

Please sign in to comment.