Skip to content

Revise 'val' parameter description in Winsorize function #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
raffaelemancuso wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revise 'val' parameter description in Winsorize function #182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions R/Winsorize.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,13 @@
#' the largest values are replaced by less extreme values. Thereby the
#' substitute values are the most extreme retained values.
#'
#'
#' The winsorized vector is obtained by
#'
#' \deqn{g(x) =
#' \left\{\begin{array}{ll}
#' -c &\textup{for } x \le c\\
#' x &\textup{for } |x| < c\\
#' c &\textup{for } x \ge c
#' \end{array}\right.
#' }{g(x)=-c, if x\le -c,
#' x, |x| < c, x, if x \ge c, c }
#'
#' You may also want to consider standardizing (possibly robustly) the data
#' before you perform a winsorization.
#'
#' @param x a numeric vector to be winsorized.
#'
#' @param val the low border, all values being lower than this will be
#' replaced by this value. The default is set to the 5%-quantile of x.
#' @param val A vector of two elements. All `x<val[1]` will be replaced by `val[1]`, and all `x>val[2]` will be replaced by `val[2]`.
#' Defaults to (5% quantile, 95% quantile).
#'
#' @return A vector of the same length as the original data \code{x} containing
#' the winsorized data.
Expand Down