Merge pull request #4 from noradno/dev

Dev

DESCRIPTION

@@ -14,4 +14,5 @@ Imports:
     ggplot2,
     grDevices,
     jsonlite,
+    showtext,
     sysfonts

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(ggnorad)
 export(norad_pal)
 export(scale_color_norad)
 export(scale_color_norad_c)

R/ggnorad.R

@@ -0,0 +1,25 @@
+#' Wrapper function to load norad theme
+#'
+#'@param ... Additional arguments
+#'@export
+#'@name ggnorad
+
+ggnorad <- function(...) {
+
+  showtext::showtext_auto()
+
+  sysfonts::font_add(family = "Arimo",
+                     regular = "fonts/Arimo-Regular.ttf",
+                     bold = "fonts/Arimo-Bold.ttf",
+                     italic = "fonts/Arimo-Italic.ttf",
+                     bolditalic = "fonts/Arimo-BoldItalic.ttf")
+  sysfonts::font_add(family = "EB Garamond",
+                     regular = "fonts/EBGaramond-Regular.ttf",
+                     bold = "fonts/EBGaramond-Bold.ttf",
+                     italic = "fonts/EBGaramond-Italic.ttf",
+                     bolditalic = "fonts/EBGaramond-BoldItalic.ttf")
+
+  ggplot2::update_geom_defaults("path", list(linewidth = 1))
+
+  ggplot2::theme_set(theme_norad())
+}

R/style_functions.R

@@ -1,10 +1,8 @@
+
 #' Function for using Norad's theme in ggplot2 graphics
+#'
 #'@export
 #'@name theme_norad
-sysfonts::font_add_google(name = "Arimo")
-sysfonts::font_add_google(name = "EB Garamond")
-
-ggplot2::update_geom_defaults("path", list(linewidth = 1))
 
 theme_norad <- function() {
   sans <- "Arimo"
@@ -21,7 +19,7 @@ theme_norad <- function() {
       plot.title.position = "plot",
       plot.title = ggplot2::element_text(
         family = serif,
-        size = 16,
+        size = 20,
         face = "bold",
         hjust = 0),
       plot.subtitle = ggplot2::element_text(

README.Rmd

@@ -28,10 +28,15 @@ Norads colour palette and plot style for creating ggplot2 graphics.
 
 library(ggplot2)
 library(noradplot)
+
+ggnorad()
+
 ggplot(mpg, aes(displ, hwy, color = class)) + 
   geom_point() +
-  theme_norad() +
-  scale_color_norad()
+  scale_color_norad() +
+  labs(title = "This is the title",
+       subtitle = "This is the slightly longer subtitle",
+       caption = "This is the caption")
 ```
 
 ## Credits

README.md

@@ -1,28 +1,39 @@
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# noradplot <img src="man/figures/sticker.png" align="right" width="120" />
+# noradplot <img src="man/figures/sticker.png" align="right" width="120"/>
 
 ## Overview
 
 Norads colour palette and plot style for creating ggplot2 graphics.
 
-## Example
+- Use `theme_norad()` to add norad style
+
+- Use `scale_*` functions to add norad colour palette
+
+## Examples
 
 ``` r
 
 library(ggplot2)
 library(noradplot)
+
+ggnorad()
+
 ggplot(mpg, aes(displ, hwy, color = class)) + 
   geom_point() +
-  theme_norad() +
-  scale_color_norad()
+  scale_color_norad() +
+  labs(title = "This is the title",
+       subtitle = "This is the slightly longer subtitle",
+       caption = "This is the caption")
 ```
 
 ![](man/figures/README-example-1.png)<!-- -->
 
-Credits: Based on Simon Jackson’s blog post: Creating corporate colour
-palettes for ggplot2, BBC BBC Visual and Data Journalism cookbook for R
-graphics: <https://bbc.github.io/rcookbook/> and Meghan Halls blog post
-Creating Custom colour palettes for ggplot2:
+## Credits
+
+Based on Simon Jackson’s blog post: Creating corporate colour palettes
+for ggplot2, BBC BBC Visual and Data Journalism cookbook for R graphics:
+<https://bbc.github.io/rcookbook/> and Meghan Halls blog post Creating
+Custom colour palettes for ggplot2:
 <https://meghan.rbind.io/blog/2022-10-11-creating-custom-color-palettes-with-ggplot2/>