Improve documentation

.Rbuildignore

@@ -12,3 +12,4 @@
 ^Meta$
 ^cran-comments\.md$
 ^CRAN-SUBMISSION$
+^vignettes/articles$

DESCRIPTION

@@ -19,22 +19,13 @@ Imports:
     lifecycle,
     rlang,
     scales
-Suggests: 
+Suggests:
     dplyr,
-    gapminder,
-    glue,
     gt,
-    knitr,
-    plotly,
-    purrr,
-    rmarkdown,
-    stringr,
     testthat (>= 2.1.0),
-    tibble,
-    tidyr
-VignetteBuilder: 
-    knitr
+    tibble
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
+Config/Needs/website: rmarkdown

NEWS.md

@@ -1,5 +1,9 @@
 # sgplot (development version)
 
+* Vignettes are converted to articles. Vignettes are now not available to view 
+locally and only via the 
+[pkgdown site](https://scotgovanalysis.github.io/sgplot/) (#66).
+
 * Set minimum version of ggplot (>= 3.5.0) (#62).
 
 * Fix bug where `use_sgplot()` could not handle passing multiple arguments of

README.Rmd

@@ -85,21 +85,25 @@ The easiest way to use sgplot is by adding `use_sgplot()` to the beginning of yo
 #### Example 1: Plot with one colour using ggplot2 defaults
 
 ```{r ex1, fig.alt = ex1_alt}
+library(sgplot)
 library(ggplot2)
 library(dplyr)
 library(gapminder)
 
 gapminder |> 
-  filter(year == 2007 & continent == "Europe") |>
-  slice_max(order_by = lifeExp, n = 5) |>
+  filter(year == 2007 & continent == "Americas") |>
+  slice_max(order_by = pop, n = 5) |>
   ggplot() +
-  geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
-  scale_y_continuous(expand = c(0, 0)) +
+  geom_col(aes(x = reorder(country, -pop), y = pop)) +
+  scale_y_continuous(
+    labels = scales::label_number(scale = 1E-6),
+    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",
+    title = "The United States is the most populous country in the Americas",
+    subtitle = "Population of countries in the Americas (millions), 2007",
     caption = "Source: Gapminder"
   )
 ```
@@ -110,16 +114,19 @@ gapminder |>
 sgplot::use_sgplot()
 
 gapminder |> 
-  filter(year == 2007 & continent == "Europe") |>
-  slice_max(order_by = lifeExp, n = 5) |>
+  filter(year == 2007 & continent == "Americas") |>
+  slice_max(order_by = pop, n = 5) |>
   ggplot() +
-  geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
-  scale_y_continuous(expand = c(0, 0)) +
+  geom_col(aes(x = reorder(country, -pop), y = pop)) +
+  scale_y_continuous(
+    labels = scales::label_number(scale = 1E-6),
+    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",
+    title = "The United States is the most populous country \nin the Americas",
+    subtitle = "Population of countries in the Americas (millions), 2007",
     caption = "Source: Gapminder"
   )
 ```

README.md

@@ -79,21 +79,25 @@ colour palettes and use `theme_sg()`.
 #### Example 1: Plot with one colour using ggplot2 defaults
 
 ``` r
+library(sgplot)
 library(ggplot2)
 library(dplyr)
 library(gapminder)
 
 gapminder |> 
-  filter(year == 2007 & continent == "Europe") |>
-  slice_max(order_by = lifeExp, n = 5) |>
+  filter(year == 2007 & continent == "Americas") |>
+  slice_max(order_by = pop, n = 5) |>
   ggplot() +
-  geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
-  scale_y_continuous(expand = c(0, 0)) +
+  geom_col(aes(x = reorder(country, -pop), y = pop)) +
+  scale_y_continuous(
+    labels = scales::label_number(scale = 1E-6),
+    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",
+    title = "The United States is the most populous country in the Americas",
+    subtitle = "Population of countries in the Americas (millions), 2007",
     caption = "Source: Gapminder"
   )
 ```
@@ -106,16 +110,19 @@ gapminder |>
 sgplot::use_sgplot()
 
 gapminder |> 
-  filter(year == 2007 & continent == "Europe") |>
-  slice_max(order_by = lifeExp, n = 5) |>
+  filter(year == 2007 & continent == "Americas") |>
+  slice_max(order_by = pop, n = 5) |>
   ggplot() +
-  geom_col(aes(x = reorder(country, -lifeExp), y = lifeExp)) +
-  scale_y_continuous(expand = c(0, 0)) +
+  geom_col(aes(x = reorder(country, -pop), y = pop)) +
+  scale_y_continuous(
+    labels = scales::label_number(scale = 1E-6),
+    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",
+    title = "The United States is the most populous country \nin the Americas",
+    subtitle = "Population of countries in the Americas (millions), 2007",
     caption = "Source: Gapminder"
   )
 ```

_pkgdown.yml

@@ -12,19 +12,23 @@ authors:
   Alice Hannah:
     html: "Alice Hannah  \
     <a href='mailto:alice.hannah@gov.scot'>\
-    <i class='fas fa-envelope' aria-hidden='true'></i>\
+    <i class='fa-solid fa-envelope' aria-hidden='true'></i>\
     <span class='visually-hidden'>Email Alice Hannah></span></a>&nbsp;&nbsp;\
     <a href='https://github.com/alice-hannah'>\
-    <i class='fab fa-github' aria-hidden='true'></i>\
+    <i class='fa-brands fa-github' aria-hidden='true'></i>\
     <span class='visually-hidden'>Alice Hannah GitHub profile></span></a>"
   Scottish Government:
     html: "Scottish Government&nbsp;&nbsp;\
+    <a href='https://www.gov.scot'>\
+    <i class='fa-solid fa-arrow-pointer' aria-hidden='true'></i>\
+    <span class='visually-hidden'>Scottish Government Website></span>\
+    </a>&nbsp;&nbsp;\
     <a href='mailto:statistics.enquiries@gov.scot'>\
-    <i class='fas fa-envelope' aria-hidden='true'></i>\
+    <i class='fa-solid fa-envelope' aria-hidden='true'></i>\
     <span class='visually-hidden'>Email Scottish Government></span></a>\
     &nbsp;&nbsp;\
     <a href='https://github.com/scotgovanalysis'>\
-    <i class='fab fa-github' aria-hidden='true'></i>\
+    <i class='fa-brands fa-github' aria-hidden='true'></i>\
     <span class='visually-hidden'>Scottish Government GitHub profile></span>\
     </a>"
   sidebar: