add alias, tests

NAMESPACE

@@ -87,6 +87,7 @@ S3method(normalize,matrix)
 S3method(normalize,numeric)
 S3method(plot,visualisation_recipe)
 S3method(print,data_codebook)
+S3method(print,data_seek)
 S3method(print,dw_data_peek)
 S3method(print,dw_data_tabulate)
 S3method(print,dw_data_tabulates)
@@ -236,6 +237,7 @@ export(data_rename_rows)
 export(data_reorder)
 export(data_restoretype)
 export(data_rotate)
+export(data_seek)
 export(data_select)
 export(data_separate)
 export(data_tabulate)

R/seek_variables.R

@@ -120,7 +120,6 @@ seek_variables <- function(data, pattern, seek = c("names", "labels"), fuzzy = F
         }
       }
     }
-    # get unique variable indices
     c(pos1, pos2, pos3)
   }))
 
@@ -143,10 +142,28 @@ seek_variables <- function(data, pattern, seek = c("names", "labels"), fuzzy = F
     character(1)
   )
 
-  data.frame(
+  out <- data.frame(
     index = pos,
     column = colnames(data)[pos],
     labels = labels,
     stringsAsFactors = FALSE
   )
+  # no row names
+  rownames(out) <- NULL
+
+  class(out) <- c("data_seek", "data.frame")
+  out
+}
+
+# alias
+#' @rdname seek_variables
+#' @export
+data_seek <- seek_variables
+
+
+# methods ---------------------------------------------------------------------
+
+#' @export
+print.data_seek <- function(x, ...) {
+  cat(insight::export_table(x, ...))
 }

tests/testthat/_snaps/data_seek.md

@@ -0,0 +1,10 @@
+# seek_variables - print
+
+    Code
+      seek_variables(iris, "Length")
+    Output
+      index |       column |       labels
+      -----------------------------------
+          1 | Sepal.Length | Sepal.Length
+          3 | Petal.Length | Petal.Length
+

tests/testthat/test-seek_data.R → tests/testthat/test-data_seek.R

@@ -75,3 +75,7 @@ test_that("seek_variables - valid input", {
   expect_error(seek_variables(rnorm(10), "Length"), regex = "`data` must be a data frame.")
   expect_error(seek_variables(iris, "Length", seek = "somewhere"), regex = "`seek` must be")
 })
+
+test_that("seek_variables - print", {
+  expect_snapshot(seek_variables(iris, "Length"))
+})