Clarify documentation of update remove_empties.R (#569)

* Update remove_empties.R Fixes #568 Feel free to edit or change, it is a bit difficult to write a clear description. Added a clarification for lower and higher values. * Update documentation of `remove_empty()` `cutoff` argument * Update R/remove_empties.R * Update R/remove_empties.R * Update R/remove_empties.R * Update R/remove_empties.R --------- Co-authored-by: Sam Firke <[email protected]>
sfirke · Nov 25, 2024 · ef4ac5f · ef4ac5f
1 parent 74345da
commit ef4ac5f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/remove_empties.R b/R/remove_empties.R
@@ -7,8 +7,8 @@
 #' @param which one of "rows", "cols", or `c("rows", "cols")`. Where no
 #'   value of which is provided, defaults to removing both empty rows and empty
 #'   columns, declaring the behavior with a printed message.
-#' @param cutoff What fraction (>0 to <=1) of rows or columns must be empty to
-#'   be removed?
+#' @param cutoff a row/col should have more than this fraction of non-NA values to be
+#'   retained.  E.g., `cutoff = 0.8` means that rows/cols that are 20% or more missing will be dropped.
 #' @param quiet Should messages be suppressed (`TRUE`) or printed
 #'   (`FALSE`) indicating the summary of empty columns or rows removed?
 #' @return Returns the object without its missing rows or columns.

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