Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
strengejacke committed Aug 13, 2023
1 parent 9aa2be1 commit 38a2d27
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
11 changes: 6 additions & 5 deletions R/row_means.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@
#'
#' @details Rounding to a negative number of `digits` means rounding to a power of
#' ten, for example `row_means(df, 3, digits = -2)` rounds to the nearest hundred.
#' For `n`, must be a numeric value from `0` to `ncol(data)`. If a row in the
#' data frame has at least `n` non-missing values, the row mean is returned. If
#' `n` is a non-integer value from 0 to 1, `n` is considered to indicate the
#' proportion of required non-missing values per row. E.g., if `n = 0.75`, a
#' row must have at least `ncol(data) * n` non-missing values for the row mean
#' For `min_valid`, if not `NULL`, `min_valid` must be a numeric value from `0`
#' to `ncol(data)`. If a row in the data frame has at least `min_valid`
#' non-missing values, the row mean is returned. If `min_valid` is a non-integer
#' value from 0 to 1, `min_valid` is considered to indicate the proportion of
#' required non-missing values per row. E.g., if `min_valid = 0.75`, a row must
#' have at least `ncol(data) * min_valid` non-missing values for the row mean
#' to be calculated. See 'Examples'.
#'
#' @examples
Expand Down
13 changes: 7 additions & 6 deletions man/row_means.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 38a2d27

Please sign in to comment.