Describe metadata type for df_label as dataset metadata

atorus-research · Jun 15, 2023 · ce91175 · ce91175
1 parent 35226d7
commit ce91175
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 26 deletions.
diff --git a/R/df_label.R b/R/df_label.R
@@ -3,6 +3,8 @@
 #' Assigns dataset label from a dataset level metadata to a given data frame.
 #' This is stored in the 'label' attribute of the dataframe.
 #'
+#' @param metadata A data frame containing dataset. See 'Metadata' section for
+#' details.
 #' @inheritParams xportr_length
 #'
 #' @return Data frame with label attributes.

diff --git a/R/length.R b/R/length.R
@@ -6,7 +6,7 @@
 #' the 'width' attribute of the column.
 #'
 #' @param .df A data frame of CDISC standard.
-#' @param metadata A data frame containing dataset/variable level metadata. See
+#' @param metadata A data frame containing variable level metadata. See
 #' 'Metadata' section for details.
 #' @param domain Appropriate CDSIC dataset name, e.g. ADAE, DM. Used to subset
 #' the metadata object. If none is passed, then name of the dataset passed as

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_metadata.Rd b/man/xportr_metadata.Rd
diff --git a/man/xportr_order.Rd b/man/xportr_order.Rd
diff --git a/man/xportr_type.Rd b/man/xportr_type.Rd