Clean up example docs for parseHeader()

- modified example for parseHeader() to print list elements separately, rather than full object, which slowed website rendering
SomaLogic · Apr 9, 2024 · 9637957 · 9637957
1 parent e66fd18
commit 9637957
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/R/parseHeader.R b/R/parseHeader.R
@@ -19,7 +19,11 @@
 #' f <- system.file("extdata", "example_data10.adat",
 #'                  package = "SomaDataIO", mustWork = TRUE)
 #' header <- parseHeader(f)
-#' header
+#' names(header)
+#' header$Header.Meta
+#' header$file_specs
+#' header$row_meta
+#' head(as.data.frame(header$Col.Meta))
 #' @importFrom stats setNames
 #' @importFrom tibble enframe
 #' @export

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