-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
70 lines (45 loc) · 3.99 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
---
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-"
)
```
# oxthema: Oxford Colours, Palettes, Fonts, and Themes <img src="man/figures/logo.png" width="200" align="right" />
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://github.com/OxfordIHTM/oxthema/actions/workflows/R-CMD-check.yaml)
[](https://github.com/OxfordIHTM/oxthema/actions/workflows/test-coverage.yaml)
[](https://app.codecov.io/gh/OxfordIHTM/oxthema?branch=main)
[](https://www.codefactor.io/repository/github/oxfordihtm/oxthema)
[](https://zenodo.org/doi/10.5281/zenodo.10721129)
<!-- badges: end -->
Colours, palettes, fonts, and themes based on [University of Oxford](https://ox.ac.uk)'s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines).
## What does `oxthema` do?
`oxthema` aims to provide templates, themes, and theme components for colour palettes, typography, and layout compliant with [University of Oxford](https://ox.ac.uk)'s [visual identity guidelines](https://communications.web.ox.ac.uk/communications-resources/visual-identity/identity-guidelines) for use in the R language for statistical computing graphics and publishing ecosystem.
The package provides colours, palettes, and fonts consistent with the university visual identity guidelines. The package also includes themes for specific packages and functionalities that make use of colours, palettes, and fonts. The package currently has themes for `{ggplot2}` and for `{forestploter}` packages.
To see a list of features that we are either actively working on, are considering, or need help on, visit our [GitHub issues](https://github.com/OxfordIHTM/oxthema/issues) page.
`oxthema` is currently in pre-release (alpha release) to allow for alpha testing of current functionalities.
## Installation
`oxthema` is not yet available on [CRAN](https://cran.r-project.org) but can be installed through the [Oxford iHealth R Universe](https://oxfordihtm.r-universe.dev) repository as follows:
```R
install.packages(
"oxthema",
repos = c('https://oxfordihtm.r-universe.dev', 'https://cloud.r-project.org')
)
```
## Usage
The following vignettes provide details on how to make full use of the `oxthema` package:
* [Oxford colours](https://oxford-ihtm.io/oxthema/articles/oxford-colours.html)
* [Oxford palettes](https://oxford-ihtm.io/oxthema/articles/oxford-palettes.html)
* [Oxford fonts](https://oxford-ihtm.io/oxthema/articles/oxford-fonts.html)
* [Oxford ggplot2 themes](https://oxford-ihtm.io/oxthema/articles/oxford-ggplot2-themes.html)
* [Oxford forestploter themes](https://oxford-ihtm.io/oxthema/articles/oxford-forestploter-themes.html)
## Community guidelines
Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/OxfordIHTM/oxthema/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://oxford-ihtm.io/oxthema/CONTRIBUTING.html).
This project is released with a [Contributor Code of Conduct](https://oxford-ihtm.io/oxthema/CODE_OF_CONDUCT.html). By participating in this project you agree to abide by its terms.