README.Rmd

---
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-",
  fig.height = 3,
  fig.width = 5
 
)
```

# NHS-R Theme <img src="https://raw.githubusercontent.com/nhs-r-community/NHSRtheme/main/inst/images/nhsrthemelogo.png" width="120" align = "right" alt = "NHSRtheme"/>

<a href='https://nhsrcommunity.com/'><img src='https://nhs-r-community.github.io/assets/logo/nhsr-logo.png' width="100"/></a> *This package is part of the NHS-R Community suite of [R packages](https://nhsrcommunity.com/packages.html).*

<!-- badges: start -->
[![R build status](https://github.com/nhs-r-community/NHSRtheme/workflows/R-CMD-check/badge.svg)](https://github.com/nhs-r-community/NHSRtheme/actions)
[![R-CMD-check](https://github.com/nhs-r-community/NHSRtheme/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nhs-r-community/NHSRtheme/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

This repo attempts to build an R package that can provide themes to ggplot for producing charts that follow the [NHS Identity](https://www.england.nhs.uk/nhsidentity/).

This package will also produce xaringan presentation slides that can be viewed as HTML. For more details please see the vignette provided.

# Installing NHSRtheme

`{NHSRtheme}` is not currently on CRAN, so you will have to install it directly from Github using devtools.

If you do not have the devtools package installed, you will have to run the first line in the code below as well.

```{r eval=FALSE}
# install.packages('devtools')
devtools::install_github('nhs-r-community/NHSRtheme')
```


## Examples

```{r,setup_bars}
library(ggplot2)
library(NHSRtheme)
df <- data.frame(x = c("a", "b", "c", "d"), y = c(3, 4, 1, 2))
bars <- ggplot(df, aes(x, y, fill = x)) + 
    geom_bar(stat = "identity") + 
    labs(x = NULL, y = NULL) +
    theme(legend.position = "none")
```


```{r default_bars}
bars + scale_fill_nhs()
```

```{r blues_bars}
bars + scale_fill_nhs(palette = 'blues')
```



```{r neutral_bars}
bars + scale_fill_nhs(palette = 'neutrals') 
```


```{r green_bars}
bars + scale_fill_nhs(palette = 'support greens')
```



```{r highlights_bars}
df2 <- data.frame(x = c("a", "b", "c", "d", "e", "f" ,"g", "h"), 
                  y = c(3, 4, 1, 2, 5, 9, 7, 4))

bars2 <- ggplot(df2, aes(x, y, fill = x)) + 
    geom_bar(stat = "identity") + 
    labs(x = NULL, y = NULL) +
    theme(legend.position = "none")

bars2 + scale_fill_nhs(palette = 'highlights')
```