Merge pull request #1817 from olivroy/doc-tweaks

Improve datasets docs, fix typo + update visual tests
rstudio · Aug 6, 2024 · 00ea7c0 · 00ea7c0 · github-actions · Aug 6, 2024
2 parents e74cf03 + 288b7ae
commit 00ea7c0
Show file tree

Hide file tree

Showing 27 changed files with 128 additions and 13 deletions.
diff --git a/R/datasets.R b/R/datasets.R
@@ -107,6 +107,8 @@
 #' @section Dataset Introduced:
 #' `v0.2.0.5` (March 31, 2020)
 #'
+#' @examples
+#' dplyr::glimpse(sza)
 "sza"
 
 #' Deluxe automobiles from the 2014-2017 period
@@ -163,6 +165,8 @@
 #' @section Dataset Introduced:
 #' `v0.2.0.5` (March 31, 2020)
 #'
+#' @examples
+#' dplyr::glimpse(gtcars)
 "gtcars"
 
 #' Daily S&P 500 Index data from 1950 to 2015
@@ -194,6 +198,8 @@
 #' @section Dataset Introduced:
 #' `v0.2.0.5` (March 31, 2020)
 #'
+#' @examples
+#' dplyr::glimpse(sp500)
 "sp500"
 
 #' A year of pizza sales from a pizza place
@@ -324,6 +330,8 @@
 #' @section Dataset Introduced:
 #' `v0.2.0.5` (March 31, 2020)
 #'
+#' @examples
+#' dplyr::glimpse(pizzaplace)
 "pizzaplace"
 
 #' A toy example tibble for testing with gt: exibble
@@ -366,6 +374,8 @@
 #' @section Dataset Introduced:
 #' `v0.2.0.5` (March 31, 2020)
 #'
+#' @examples
+#' exibble
 "exibble"
 
 #' Populations of all municipalities in Ontario from 1996 to 2021
@@ -432,6 +442,8 @@
 #' @section Dataset Introduced:
 #' `v0.9.0` (Mar 31, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(towny)
 "towny"
 
 #' A table of personal information for people all over the world
@@ -482,6 +494,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(peeps)
 "peeps"
 
 
@@ -528,6 +542,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(films)
 "films"
 
 #' The stations of the Paris Metro
@@ -595,6 +611,8 @@
 #' @section Dataset Introduced:
 #' `v0.9.0` (Mar 31, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(metro)
 "metro"
 
 #' Weather conditions in Gibraltar, May 2023
@@ -633,6 +651,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(gibraltar)
 "gibraltar"
 
 #' The fundamental physical constants
@@ -674,6 +694,8 @@
 #' @section Dataset Introduced:
 #' `v0.10.0` (October 7, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(constants)
 "constants"
 
 #' Lab tests for one suffering from an illness
@@ -759,6 +781,8 @@
 #' @section Dataset Introduced:
 #' `v0.10.0` (October 7, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(illness)
 "illness"
 
 #' Reaction rates for gas-phase atmospheric reactions of organic compounds
@@ -855,6 +879,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(reactions)
 "reactions"
 
 #' Data on photolysis rates for gas-phase organic compounds
@@ -906,6 +932,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(photolysis)
 "photolysis"
 
 #' Nuclide data
@@ -959,6 +987,8 @@
 #' @section Dataset Introduced:
 #' `v0.11.0` (July 9, 2024)
 #'
+#' @examples
+#' dplyr::glimpse(nuclides)
 "nuclides"
 
 #' An ADSL-flavored clinical trial toy dataset
@@ -1021,6 +1051,8 @@
 #' @section Dataset Introduced:
 #' `v0.9.0` (Mar 31, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(rx_adsl)
 "rx_adsl"
 
 #' An ADDV-flavored clinical trial toy dataset
@@ -1086,4 +1118,6 @@
 #' @section Dataset Introduced:
 #' `v0.9.0` (Mar 31, 2023)
 #'
+#' @examples
+#' dplyr::glimpse(rx_addv)
 "rx_addv"
diff --git a/R/tab_options.R b/R/tab_options.R
@@ -105,7 +105,7 @@
 #'   elements: `heading.title`, `heading.subtitle`, `column_labels`,
 #'   `row_group`, `footnotes`, and `source_notes`. Can be specified as a
 #'   single-length character vector with units of pixels (e.g., `12px`) or as a
-#'   percentage (e.g., `80\%`). If provided as a single-length numeric vector,
+#'   percentage (e.g., `80%`). If provided as a single-length numeric vector,
 #'   it is assumed that the value is given in units of pixels. The [px()] and
 #'   [pct()] helper functions can also be used to pass in numeric values and
 #'   obtain values as pixel or percentage units.

diff --git a/man/constants.Rd b/man/constants.Rd
diff --git a/man/exibble.Rd b/man/exibble.Rd
diff --git a/man/films.Rd b/man/films.Rd
diff --git a/man/gibraltar.Rd b/man/gibraltar.Rd
diff --git a/man/grp_options.Rd b/man/grp_options.Rd
diff --git a/man/gtcars.Rd b/man/gtcars.Rd
diff --git a/man/illness.Rd b/man/illness.Rd
diff --git a/man/metro.Rd b/man/metro.Rd
diff --git a/man/nuclides.Rd b/man/nuclides.Rd
diff --git a/man/peeps.Rd b/man/peeps.Rd
diff --git a/man/photolysis.Rd b/man/photolysis.Rd
diff --git a/man/pizzaplace.Rd b/man/pizzaplace.Rd
diff --git a/man/reactions.Rd b/man/reactions.Rd
diff --git a/man/rx_addv.Rd b/man/rx_addv.Rd
diff --git a/man/rx_adsl.Rd b/man/rx_adsl.Rd
diff --git a/man/sp500.Rd b/man/sp500.Rd
diff --git a/man/sza.Rd b/man/sza.Rd
diff --git a/man/tab_options.Rd b/man/tab_options.Rd
diff --git a/man/towny.Rd b/man/towny.Rd
diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml
@@ -393,6 +393,7 @@ articles:
 - title: Get started
   navbar: ~
   contents:
+  - gt
   - creating-summary-lines
 - title: Case studies
   navbar: Case studies
@@ -401,6 +402,7 @@ articles:
   - case-study-clinical-tables
 
 - title: Datasets
+  navbar: Datasets
   contents:
   - gt-datasets
 - title: Visual tests

diff --git a/pkgdown/assets/gt-latex.pdf b/pkgdown/assets/gt-latex.pdf