Removes rows/columns in an array-like object using a predicate function.
Usage
discard(x, ...)
discard_columns(x, ...)
discard_rows(x, ...)
# S4 method for class 'ANY'
discard(
x,
f,
margin = 1,
negate = FALSE,
all = FALSE,
na.rm = FALSE,
verbose = getOption("arkhe.verbose"),
...
)
# S4 method for class 'ANY'
discard_rows(
x,
f,
negate = FALSE,
all = FALSE,
na.rm = FALSE,
verbose = getOption("arkhe.verbose"),
...
)
# S4 method for class 'ANY'
discard_columns(
x,
f,
negate = FALSE,
all = FALSE,
na.rm = FALSE,
verbose = getOption("arkhe.verbose"),
...
)
Arguments
- x
An R object (should be a
matrix
or adata.frame
).- ...
Further arguments to be passed to
f
.- f
A predicate
function
.- margin
A length-one
numeric
vector giving the subscripts which the function will be applied over (1
indicates rows,2
indicates columns).- negate
A
logical
scalar: should the negation off
be used instead off
?- all
A
logical
scalar. IfTRUE
, only the rows/columns whose values all meet the condition defined byf
are considered. IfFALSE
(the default), only rows/columns where at least one value validates the condition defined byf
are considered.- na.rm
A
logical
scalar: shouldNA
values be stripped before the computation proceeds?- verbose
A
logical
scalar: should R report extra information on progress?
See also
Other data preparation tools:
append_column()
,
append_rownames()
,
assign()
,
compact()
,
count()
,
detect()
,
get()
,
keep()
,
seek()
Examples
## Create a data matrix
X <- matrix(sample(1:10, 25, TRUE), nrow = 5, ncol = 5)
## Add NA
k <- sample(1:25, 3, FALSE)
X[k] <- NA
X
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 5 4 2 6 8
#> [2,] 2 2 6 7 NA
#> [3,] 9 NA 10 8 9
#> [4,] 8 NA 9 6 4
#> [5,] 5 3 5 10 9
## Remove row with any NA
discard(X, f = is.na, margin = 1, all = FALSE)
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 5 4 2 6 8
#> [2,] 5 3 5 10 9
## Remove column with any NA
discard(X, f = is.na, margin = 2, all = FALSE)
#> [,1] [,2] [,3]
#> [1,] 5 2 6
#> [2,] 2 6 7
#> [3,] 9 10 8
#> [4,] 8 9 6
#> [5,] 5 5 10