#docs: example and ref blurb

R/write.R

@@ -23,6 +23,17 @@
 #'
 #' @return A data frame. `xportr_write()` returns the input data invisibly.
 #' @export
+#'
+#' @examples
+#' adsl <- data.frame(
+#' Subj = as.character(123, 456, 789),
+#' Different = c("a", "b", "c"),
+#' Val = c("1", "2", "3"),
+#' Param = c("param1", "param2", "param3")
+#' )
+#'
+#' xportr_write(adsl, path = "adsl.xpt", label = "Subject-Level Analysis", strict_checks = FALSE)
+#'
 xportr_write <- function(.df, path, label = NULL, strict_checks = FALSE) {
  path <- normalizePath(path, mustWork = FALSE)
 

_pkgdown.yml

@@ -19,25 +19,27 @@ navbar:
  aria-label: slack
 
 reference:
- - title: The six core xportr functions
+ - title:  Core xportr functions
  - contents:
  - xportr_type
  - xportr_length
  - xportr_label
  - xportr_write
  - xportr_format
  - xportr_order
+ - xportr_df_label
+ - xportr_metadata
 
  - title: xportr helper functions
+ desc: Utility functions called within core xportr functions
  - contents:
  - label_log
  - length_log
  - type_log
  - var_names_log
  - var_ord_msg
  - xportr_logger
- - xportr_df_label
- - xportr_metadata
+
 
  - title: xportr example datasets and specification files
  - contents: