R2DT (version 0.2)

isLogicalDT: Testing if a set of columns of a data.table object corresponds to the logical/boolean data type

Description

Testing if a set of columns of a data.table object corresponds to the logical/boolean data type

Usage

isLogicalDT(inputDT, colNamesToBeChecked = NULL, returnNames = FALSE)

Arguments

inputDT

data.table object containing the data of interest. This is an obligatory argument, without default value.

colNamesToBeChecked

Character vector containing potential column names of the 'inputDT' argument. The default value is NULL.

returnNames

Logical vector of length 1 indicating whether or not the column name of the selected booleans should be returned. The default value is FALSE.

Value

A logical vector of length the size of the 'colNamesToBeChecked' argument, or in the absence of a value the number of columns of the 'inputDT' argument, that is TRUE if the corresponding column of the 'inputDT' argument is a boolean. If the 'returnNames' argument equals TRUE, then only those column names from the aforementioned selection of column of the 'inputDT' argument are returned that are a boolean.

Examples

# NOT RUN {
library(data.table)
inputDT <- as.data.table(data.frame(x = rep(c(TRUE, FALSE), 5), y = LETTERS[1:10]))
asFactorDT(inputDT, c('y'))

isLogicalDT(inputDT)
isLogicalDT(inputDT, c('x', 'y'))
isLogicalDT(inputDT, returnNames = TRUE)

isLogicalDT(inputDT, 'x')
# }
# NOT RUN {
isLogicalDT(inputDT, c('x', 'y1'))
# }