add additional doc to driver telem

As per discussion in SCasanova#78
pbulsink · Jul 10, 2023 · 81c2c0e · 81c2c0e
1 parent 5012eaf
commit 81c2c0e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/R/load_driver_telemetry.R b/R/load_driver_telemetry.R
@@ -2,6 +2,9 @@
 #'
 #' @description Receives season, race number, driver code, and an optional fastest lap only
 #' argument to output car telemetry for the selected situation.
+#' Example usage of this code can be seen in the Introduction vignette (run
+#' `vignette('introduction', 'f1dataR')` to read). Multiple drivers' telemetry can be appended
+#' to one data frame by the user.
 #'
 #' @param season number from 2018 to current season (defaults to current season).
 #' @param round number from 1 to 23 (depending on season selected). Also accepts race name.

diff --git a/man/load_driver_telemetry.Rd b/man/load_driver_telemetry.Rd