Document new data

R/data.R

@@ -9,8 +9,8 @@
 #' @aliases si_centroids
 #' @examples
 #' si_zones
-#' plot(si_zones$geometry)
-#' plot(si_centroids$geometry, add = TRUE)
+#' sf:::plot.sfg(si_zones$geometry)
+#' sf:::plot.sfg(si_centroids$geometry, add = TRUE)
 NULL
 
 #' Example OD dataset
@@ -70,7 +70,7 @@ NULL
 #' @name zones_york
 #' @examples
 #' head(zones_york)
-#' plot(zones_york$geometry)
+#' sf:::plot.sfg(zones_york$geometry)
 NULL
 
 #' Example destinations dataset: schools in York
@@ -84,4 +84,39 @@ NULL
 #' @name destinations_york
 #' @examples
 #' head(destinations_york)
+NULL
+
+#' Origin-Destination Data for Leeds
+#' 
+#' This dataset contains origin-destination data for Leeds, including the number of trips between output areas (OAs) and workplace zones (WPZs).
+#' 
+#' @docType data
+#' @keywords datasets
+#' @name si_oa_wpz
+#' @examples
+#' head(si_oa_wpz)
+NULL
+
+#' Origin Data for Leeds
+#' 
+#' This dataset contains the number of trips originating from each output area (OA) in Leeds.
+#' 
+#' @docType data
+#' @keywords datasets
+#' @name si_oa_wpz_o
+#' @examples
+#' head(si_oa_wpz_o)
+#' sf:::plot.sf(si_oa_wpz_o["n_o"])
+NULL
+
+#' Destination Data for Leeds
+#' 
+#' This dataset contains the number of trips destined for each workplace zone (WPZ) in Leeds.
+#' 
+#' @docType data
+#' @keywords datasets
+#' @name si_oa_wpz_d
+#' @examples
+#' head(si_oa_wpz_d)
+#' sf:::plot.sf(si_oa_wpz_d["n_d"])
 NULL

README.qmd

@@ -193,4 +193,5 @@ bench::mark(
 usethis::use_github_action("check-standard")
 # Add pkgdown action:
 usethis::use_github_action("pkgdown")
+usethis::use_data_raw("si_oa_wpz")
 ```