Doc updates per #261 (#264)

atorus-research · Mar 22, 2024 · 0c7d34e · 0c7d34e
1 parent 1231e54
commit 0c7d34e
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 27 deletions.
diff --git a/R/split.R b/R/split.R
@@ -21,15 +21,13 @@
 #' @export
 #'
 #' @examples
-#' data("adsl_xportr")
-#' adsl <- adsl_xportr
 #'
 #' adlb <- data.frame(
 #' USUBJID = c(1001, 1002, 1003),
 #' LBCAT = c("HEMATOLOGY", "HEMATOLOGY", "CHEMISTRY")
 #' )
 #'
-#' adsl <- xportr_split(adsl, "LBCAT")
+#' adlb <- xportr_split(adlb, "LBCAT")
 xportr_split <- function(.df, split_by = NULL) {
  attr(.df, "_xportr.split_by_") <- split_by
 

diff --git a/R/xportr-package.R b/R/xportr-package.R
@@ -127,7 +127,7 @@ globalVariables(c(
  "abbr_parsed", "abbr_stem", "adj_orig", "adj_parsed", "col_pos", "dict_varname",
  "lower_original_varname", "my_minlength", "num_st_ind", "original_varname",
  "renamed_n", "renamed_var", "use_bundle", "viable_start", "type.x", "type.y",
- "variable", "length.x", "lenght.y", "e", "length_df", "length_meta"
+ "variable", "length.x", "lenght.y", "e", "length_df", "length_meta", ".env"
 ))
 
 # The following block is used by usethis to automatically manage

diff --git a/R/xportr.R b/R/xportr.R
@@ -3,8 +3,7 @@
 #' @param .df A data frame of CDISC standard.
 #' @param var_metadata A data frame containing variable level metadata
 #' @param domain Appropriate CDISC dataset name, e.g. ADAE, DM. Used to subset
-#' the metadata object. If none is passed, then name of the dataset passed as
-#' .df will be used.
+#' the metadata object.
 #' @param verbose The action this function takes when an action is taken on the
 #' dataset or function validation finds an issue. See 'Messaging' section for
 #' details. Options are 'stop', 'warn', 'message', and 'none'

diff --git a/man/metadata.Rd b/man/metadata.Rd
diff --git a/man/xportr.Rd b/man/xportr.Rd
diff --git a/man/xportr_df_label.Rd b/man/xportr_df_label.Rd
diff --git a/man/xportr_format.Rd b/man/xportr_format.Rd
diff --git a/man/xportr_label.Rd b/man/xportr_label.Rd
diff --git a/man/xportr_length.Rd b/man/xportr_length.Rd
diff --git a/man/xportr_order.Rd b/man/xportr_order.Rd
diff --git a/man/xportr_split.Rd b/man/xportr_split.Rd
diff --git a/man/xportr_type.Rd b/man/xportr_type.Rd
diff --git a/man/xportr_write.Rd b/man/xportr_write.Rd