sc_cols_positive {sanityTracker}R Documentation

Checks that all elements from the specified columns are positive

Description

Checks that all elements from the specified columns are positive

Usage

sc_cols_positive(object, cols, zero_feasible = TRUE, ...)

Arguments

object

table with a columns specified by cols

cols

vector of characters of columns that are checked against the specified range

zero_feasible

if zero is in the range or not

...

further parameters that are passed to add_sanity_check.

Value

list of logical vectors where TRUE indicates where the check failed. Every list entry represents one of the columns specified in cols. This might be helpful if one wants to apply a counter-measure.

Examples

d <- data.frame(a = c(0, 0.2, 3, Inf), b = c(1:4))
dummy_call <- function(x) {
  sc_cols_positive(d, cols = c("a", "b"), zero_feasible = FALSE,
    description = "Measurements are expected to be positive")
}
dummy_call(x = d)
get_sanity_checks()

[Package sanityTracker version 0.1.0 Index]