A dependency-free collection of simple functions for cleaning rectangular data. This package allows to detect, count and replace values or discard rows/columns using a predicate function. In addition, it provides tools to check conditions and return informative error messages.
To cite arkhe in publications use:
Frerebeau N (2024). arkhe: Tools for Cleaning Rectangular Data. Université Bordeaux Montaigne, Pessac, France. doi:10.5281/zenodo.3526659 https://doi.org/10.5281/zenodo.3526659, R package version 1.7.0, https://packages.tesselle.org/arkhe/.
This package is a part of the tesselle project https://www.tesselle.org.
You can install the released version of arkhe from CRAN with:
install.packages("arkhe")And the development version from GitHub with:
# install.packages("remotes")
remotes::install_github("tesselle/arkhe")## Load the package
library(arkhe)
## Create a 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,] 7 8 9 1 NA
#> [2,] 8 9 7 2 3
#> [3,] 8 NA 2 10 2
#> [4,] 4 7 7 5 3
#> [5,] 4 7 NA 6 1
## Count missing values in rows
count(X, f = is.na, margin = 1)
#> [1] 1 0 1 0 1
## Count non-missing values in columns
count(X, f = is.na, margin = 2, negate = TRUE)
#> [1] 5 4 4 5 4
## Find row with NA
detect(X, f = is.na, margin = 1)
#> [1] TRUE FALSE TRUE FALSE TRUE
## Find column without any NA
detect(X, f = is.na, margin = 2, negate = TRUE, all = TRUE)
#> [1] TRUE FALSE FALSE TRUE FALSE
## Remove row with any NA
discard(X, f = is.na, margin = 1, all = FALSE)
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 8 9 7 2 3
#> [2,] 4 7 7 5 3
## Remove column with any NA
discard(X, f = is.na, margin = 2, all = FALSE)
#> [,1] [,2]
#> [1,] 7 1
#> [2,] 8 2
#> [3,] 8 10
#> [4,] 4 5
#> [5,] 4 6
## Replace NA with zeros
replace_NA(X, value = 0)
#> [,1] [,2] [,3] [,4] [,5]
#> [1,] 7 8 9 1 0
#> [2,] 8 9 7 2 3
#> [3,] 8 0 2 10 2
#> [4,] 4 7 7 5 3
#> [5,] 4 7 0 6 1Please note that the arkhe project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.