View source: R/prune_02B_fence.R
prune_fence  R Documentation 
Identify the rows outside the fence.
prune_fence(data, cols, is_offset = TRUE, info = FALSE)
data 
Dataframe. 
cols 
Names of columns to apply 
is_offset 
If TRUE (default) the offset number will be

info 
If FALSE (default) a logical vector with the is returned. If TRUE a list with the logical vector is returned as well as the slopes. This is used usually to help plot the fences. 
Compute the fence to eliminate values that are clearly outofbound.
Normally all values should be nonnegative. In case they are not, and
offset is used. Also, sometimes the data is nowhere near zero and is such
cases the fence is not useful, again in that case the offset solves that
problem. The algorithm will generate an error when Inf, Inf
values
are in the input. The NA
are treated as being outofbound.
If info = FALSE
(default), logical vector where TRUE indicates
values outside the fence. If info = TRUE
, a list with
the logical vector called is_outside
, the list of slopes called
slopes
, the list of offsets called offsets
, and the data.frame
of fences data fences
.
if the argument info
is set to TRUE
then a list with the following elements is given.
Logical vector, TRUE is when the row is outside the fence limits, FALSE otherwise.
The slopes for the small and big fences.
The offset used to scale the x and y values.
Dataframe with x = original x values; y = original y values, small = y value of the small fence on the scaled coordinates; big = y value of the big fence on the scaled coordinates; small_inv = y value of the small fence on the original scale (useful for plotting); big_inv = y value of the big fence on the original scale (useful for plotting.)
Statistical Data Cleaning, Mark van der Loo and Edwin de Jonge, 2018. Section 7.5.2, p. 176179.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.