-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
139 lines (102 loc) · 5.7 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
---
output: github_document
editor_options:
chunk_output_type: console
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
warning = FALSE,
error = FALSE,
message = FALSE,
comment = "#>",
fig.path = "man/figures/README-",
dev = "svg"
)
ex1_alt <- paste("A bar chart with grey background, white grid lines",
"and dark grey bars.")
ex2_alt <- paste("A bar chart with white background,",
"light grey horizontal grid lines dark blue bars.")
```
# sgplot <img src="man/figures/logo.svg" alt="sgplot logo" align="right" height="150"/>
<!-- badges: start -->
[](https://github.com/ScotGovAnalysis/sgplot/releases/latest) [](https://github.com/ScotGovAnalysis/sgplot/actions)
<!-- badges: end -->
sgplot is an R package for creating accessible plots in the Scottish Government. Currently, functions are available for styling ggplot2 plots.
The package has been developed using the [Government Analysis Function Data Visualisation guidance](https://analysisfunction.civilservice.gov.uk/policy-store/data-visualisation-charts/) and uses accessible colour palettes from the [Scottish Government Design System](https://designsystem.gov.scot/guidance/charts/data-visualisation-colour-palettes).
sgplot should be used in conjunction with these guidance documents.
More information about the package and its functions can be found on the [sgplot website](https://ScotGovAnalysis.github.io/sgplot).
In particular, the [cookbook](https://ScotGovAnalysis.github.io/sgplot/articles/cookbook.html) contains lots of examples.
Slides are also available for an internal [presentation given to statisticians and analysts](https://alice-hannah.github.io/presentations-and-blogs/2023-06-19_sgplot/slides.html).
## Installation
If you are working within the Scottish Government network, you can install sgplot in the same way as with other R packages. The easiest way to do this is by using the [pkginstaller](https://github.com/ScotGovAnalysis/pkginstaller/tree/main) add-in. Further guidance is available on [eRDM](https://erdm.scotland.gov.uk:8443/documents/A42404229/details).
Alternatively, sgplot can be installed directly from GitHub. Note that this method requires the remotes package and may not work from within the Scottish Government network.
``` r
remotes::install_github(
"ScotGovAnalysis/sgplot",
upgrade = "never",
build_vignettes = TRUE
)
```
Finally, sgplot can also be installed by downloading the [zip of the repository](https://github.com/ScotGovAnalysis/sgplot/archive/main.zip) and running the following code, replacing the section marked `<>` (including the arrows themselves) with the location of the downloaded zip:
``` r
remotes::install_local(
"<FILEPATH OF ZIPPED FILE>/sgplot-main.zip",
upgrade = "never",
build_vignettes = TRUE
)
```
## Getting Started
Once installed, sgplot can be loaded using the `library()` function:
``` r
library(sgplot)
```
Help files for each function in the package can be found on the [References](https://ScotGovAnalysis.github.io/sgplot/reference) page of the package website. Alternatively, type `?function_name` into the RStudio console. For example:
``` r
?theme_sg()
```
### Use sgplot as default
The easiest way to use sgplot is by adding `use_sgplot()` to the beginning of your R script, Rmarkdown document or Shiny app code. This function will set a number of defaults to ggplot2 geoms, use sgplot colour palettes and use `theme_sg()`.
#### Example 1: Plot with one colour using ggplot2 defaults
```{r ex1, fig.alt = ex1_alt}
library(ggplot2)
library(dplyr)
library(gapminder)
gapminder |>
filter(year == 2007 & continent == "Europe") |>
slice_max(order_by = lifeExp, n = 5) |>
ggplot() +
geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
scale_y_continuous(expand = c(0, 0)) +
labs(
x = NULL,
y = NULL,
title = "Iceland has the highest life expectancy in Europe",
subtitle = "Life expectancy in European countries, 2007",
caption = "Source: Gapminder"
)
```
#### Example 2: Plot with one colour using sgplot defaults
```{r ex2, fig.alt = ex2_alt}
sgplot::use_sgplot()
gapminder |>
filter(year == 2007 & continent == "Europe") |>
slice_max(order_by = lifeExp, n = 5) |>
ggplot() +
geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
scale_y_continuous(expand = c(0, 0)) +
labs(
x = NULL,
y = NULL,
title = "Iceland has the highest life expectancy in Europe",
subtitle = "Life expectancy in European countries, 2007",
caption = "Source: Gapminder"
)
```
**Note on use of titles, subtitles and captions** <br>
Titles, subtitles and captions have been embedded in these example charts for demonstration purposes. However, for accessibility reasons, it is usually preferable to provide titles in the body of the page rather than embedded within the image of the plot. More information is available in the [accessibility article](https://ScotGovAnalysis.github.io/sgplot/articles/accessibility.html#other-accessibility-considerations).
## Licence
Unless stated otherwise, the codebase is released under [the MIT License](LICENSE). This covers both the codebase and any sample code in the documentation.
The documentation is [© Crown copyright](http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms
of the [Open Government 3.0](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/) licence.