Repository navigation
Expand file tree
/
Copy pathREADME.Rmd
More file actions
57 lines (41 loc) · 1.73 KB
/
Copy pathREADME.Rmd
File metadata and controls
57 lines (41 loc) · 1.73 KB
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-",
out.width = "100%"
)
```
# ectrlplot <img src="man/figures/logo.svg" class="logo" />
<!-- badges: start -->
[](https://cran.r-project.org/package=ectrlplot)
[](https://github.com/euctrl-pru/ectrlplot/actions)
<!-- badges: end -->
## Overview
The `ectrlplot` package provides helpful functions for creating and exporting graphics made in ggplot2 in the style used by the PRU team.
It is inspired by BBC [bbplot](https://github.com/bbc/bbplot) package.
## Installation
You can install the development version of `ectrlplot` from
[GitHub](https://github.com/euctrl-pru/ectrlplot) with:
```r
# install.packages('devtools')
devtools::install_github("euctrl-pru/ectrlplot")
```
or the CRAN version (when this package will land to CRAN):
```r
install.packages("ectrlplot")
```
## Usage
`ectrlplot` can be used to (example numbers refer to the
ones in the [vignette][vignette]):
* Add the PRU theme ([Example 1.1][ex1]).
* Use the PRU colour palette ([Example 1.2][ex2])
* Add logo and source ([Example 1.3][ex3]).
[vignette]: <https://ectrlplot.ansperformance.eu/articles/my-vignette.html> "ectrlplot vignette"
[ex1]: <https://ectrlplot.ansperformance.eu/articles/my-vignette.html#example-01> "Example 1.1"
[ex2]: <https://ectrlplot.ansperformance.eu/articles/my-vignette.html#example-02> "Example 1.2"
[ex3]: <https://ectrlplot.ansperformance.eu/articles/my-vignette.html#example-03> "Example 1.3"