arkhe

Overview

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.

Installation

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")

Usage

## 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,]    2    5   NA    6   NA
#> [2,]    4    1    5    2    5
#> [3,]    2    6   NA    6   10
#> [4,]    1    7    6    5    6
#> [5,]    6    1    8    8    6

## Count missing values in rows
count(X, f = is.na, margin = 1)
#> [1] 2 0 1 0 0
## Count non-missing values in columns
count(X, f = is.na, margin = 2, negate = TRUE)
#> [1] 5 5 3 5 4

## Find row with NA
detect(X, f = is.na, margin = 1)
#> [1]  TRUE FALSE  TRUE FALSE FALSE
## Find column without any NA
detect(X, f = is.na, margin = 2, negate = TRUE, all = TRUE)
#> [1]  TRUE  TRUE FALSE  TRUE FALSE

## Remove row with any NA
discard(X, f = is.na, margin = 1, all = FALSE)
#>      [,1] [,2] [,3] [,4] [,5]
#> [1,]    4    1    5    2    5
#> [2,]    1    7    6    5    6
#> [3,]    6    1    8    8    6
## Remove column with any NA
discard(X, f = is.na, margin = 2, all = FALSE)
#>      [,1] [,2] [,3]
#> [1,]    2    5    6
#> [2,]    4    1    2
#> [3,]    2    6    6
#> [4,]    1    7    5
#> [5,]    6    1    8

## Replace NA with zeros
replace_NA(X, value = 0)
#>      [,1] [,2] [,3] [,4] [,5]
#> [1,]    2    5    0    6    0
#> [2,]    4    1    5    2    5
#> [3,]    2    6    0    6   10
#> [4,]    1    7    6    5    6
#> [5,]    6    1    8    8    6

Contributing

Please 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.