Add more documentation for vector

coatless-rpkg · Jan 15, 2024 · 178c122 · 178c122
1 parent ed713b3
commit 178c122
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/R/vector.R b/R/vector.R
@@ -21,9 +21,16 @@
 #' @examples
 #' # Base graphics
 #' 
-#' # Visualize a 3x3
+#' # Visualize a nine element vector
 #' vec_9 <- round(rnorm(5, 0, 4), 2)
 #' draw_vector(vec_9)
+#' 
+#' # Visualize a 6 element vector with indices underneath data
+#' vec_6 <- c(-3, 5, NA, Inf, 2, 1)
+#' draw_vector(vec_6, show_indices = "inside")
+#' 
+#' # Highlight the 2nd, 4th, and 6th cell with indices shown outside
+#' draw_vector(vec_6, show_indices = "outside", highlight_area = c(2, 4, 6))
 draw_vector <- function(
     data,
     layout = c("vertical", "horizontal"),

diff --git a/man/draw-vector.Rd b/man/draw-vector.Rd