improved the documentation

dfe-analytical-services · Oct 11, 2024 · a0824c3 · a0824c3
1 parent bf524d4
commit a0824c3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/R/pretty.R b/R/pretty.R
@@ -315,11 +315,12 @@ pretty_num <- function(
   return(unlist(result))
 }
 
-#' Format columns in a Data Frame with `dfeR::pretty_num`.
+#' Format a data frame with `dfeR::pretty_num`.
 #'
+#' You can format number and character values in a data frame
+#' by passing arguments to `dfeR::pretty_num`.
 #' Use parameters `include_columns` or `exclude_columns`
-#' to specify columns for formatting
-#' and pass arguments to `dfeR::pretty_num` for number formatting
+#' to specify columns for formatting.
 #'
 #' @param data A data frame containing the columns to be formatted.
 #' @param include_columns A character vector specifying which columns to format.

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