README.md

In IainMoppett/testpackage: Helper Functions for HSRC Projects

testpackage

The goal of testpackage is to provide some helper functions for people working with HSRC or other projects.

There are currently three independent tools.

pretty_plot adds a logo and some text (e.g. source, date etc) to a plot. theme_HSRC creates a ggplot theme QR_save generates a series of QR codes from a csv file of URLs and titles. Useful for presentations.

Installation

You can install the development version of testpackage from GitHub with:

# install.packages("devtools")
devtools::install_github("IainMoppett/testpackage")

Example

QR_save

Use the QR_save function to save a series of pdfs of QR codes with a helpful title. Online tools tend to give a rather unhelpful ‘file.png’ as the output.

library(testpackage)
## basic example code

QR_save(system.file("extdata", "QR_Data.csv", package = "testpackage"))
#> Rows: 3 Columns: 2
#> ── Column specification ────────────────────────────────────────────────────────
#> Delimiter: ","
#> chr (2): URL, Title
#> 
#> ℹ Use `spec()` to retrieve the full column specification for this data.
#> ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.

Pretty_plot

Adds a logo at the bottom right and some text (e.g. data source) at the bottom left. Plots can be set-up using whatever themes you choose. Or you can override the theme with theme_HSRC by setting theme_apply to TRUE.

You can also add facet plot formatting in the same style with facet_apply as TRUE.

Two native test plots

Pretty_plot function applied to the test plots

IainMoppett/testpackage documentation built on Feb. 4, 2023, 11 p.m.