Fast and Versatile Argument Checks


[Up] [Top]

Documentation for package ‘checkmate’ version 2.0.0

Help Pages

A C E M Q R T V W misc

checkmate-package checkmate: Fast and Versatile Argument Checks

-- A --

allMissing Check if an object contains missing values
anyInfinite Check if an object contains infinite values
anyMissing Check if an object contains missing values
anyNaN Check if an object contains NaN values
asCount Convert an argument to an integer
asInt Convert an argument to an integer
asInteger Convert an argument to an integer
assert Combine multiple checks into one assertion
assertAccess Check file system access rights
assertArray Check if an argument is an array
assertAtomic Check that an argument is an atomic vector
assertAtomicVector Check that an argument is an atomic vector
assertCharacter Check if an argument is a vector of type character
assertChoice Check if an object is an element of a given set
assertClass Check the class membership of an argument
AssertCollection Collect multiple assertions
assertComplex Check if an argument is a vector of type complex
assertCount Check if an argument is a count
assertDataFrame Check if an argument is a data frame
assertDataTable Check if an argument is a data table
assertDate Check that an argument is a Date
assertDirectory Check for existence and access rights of directories
assertDirectoryExists Check for existence and access rights of directories
assertDisjunct Check if an argument is disjunct from a given set
assertDouble Check that an argument is a vector of type double
assertEnvironment Check if an argument is an environment
assertFactor Check if an argument is a factor
assertFALSE Check if an argument is FALSE
assertFile Check existence and access rights of files
assertFileExists Check existence and access rights of files
assertFlag Check if an argument is a flag
assertFormula Check if an argument is a formula
assertFunction Check if an argument is a function
assertInt Check if an argument is a single integerish value
assertInteger Check if an argument is vector of type integer
assertIntegerish Check if an object is an integerish vector
assertList Check if an argument is a list
assertLogical Check if an argument is a vector of type logical
assertMatrix Check if an argument is a matrix
assertMultiClass Check the class membership of an argument
assertNamed Check if an argument is named
assertNames Check names to comply to specific rules
assertNull Check if an argument is NULL
assertNumber Check if an argument is a single numeric value
assertNumeric Check that an argument is a vector of type numeric
assertOS Check the operating system
assertPathForOutput Check if a path is suited for creating an output file
assertPOSIXct Check that an argument is a date/time object in POSIXct format
assertR6 Check if an argument is a R6 class
assertRaw Check if an argument is a raw vector
assertScalar Check if an argument is a single atomic value
assertScalarNA Check if an argument is a single missing value
assertSetEqual Check if an argument is equal to a given set
assertString Check if an argument is a string
assertSubset Check if an argument is a subset of a given set
assertTibble Check if an argument is a tibble
assertTRUE Check if an argument is TRUE
assertVector Check if an argument is a vector
assert_access Check file system access rights
assert_array Check if an argument is an array
assert_atomic Check that an argument is an atomic vector
assert_atomic_vector Check that an argument is an atomic vector
assert_character Check if an argument is a vector of type character
assert_choice Check if an object is an element of a given set
assert_class Check the class membership of an argument
assert_complex Check if an argument is a vector of type complex
assert_count Check if an argument is a count
assert_data_frame Check if an argument is a data frame
assert_data_table Check if an argument is a data table
assert_date Check that an argument is a Date
assert_directory Check for existence and access rights of directories
assert_directory_exists Check for existence and access rights of directories
assert_disjunct Check if an argument is disjunct from a given set
assert_double Check that an argument is a vector of type double
assert_environment Check if an argument is an environment
assert_factor Check if an argument is a factor
assert_false Check if an argument is FALSE
assert_file Check existence and access rights of files
assert_file_exists Check existence and access rights of files
assert_flag Check if an argument is a flag
assert_formula Check if an argument is a formula
assert_function Check if an argument is a function
assert_int Check if an argument is a single integerish value
assert_integer Check if an argument is vector of type integer
assert_integerish Check if an object is an integerish vector
assert_list Check if an argument is a list
assert_logical Check if an argument is a vector of type logical
assert_matrix Check if an argument is a matrix
assert_multi_class Check the class membership of an argument
assert_named Check if an argument is named
assert_names Check names to comply to specific rules
assert_null Check if an argument is NULL
assert_number Check if an argument is a single numeric value
assert_numeric Check that an argument is a vector of type numeric
assert_os Check the operating system
assert_path_for_output Check if a path is suited for creating an output file
assert_posixct Check that an argument is a date/time object in POSIXct format
assert_r6 Check if an argument is a R6 class
assert_raw Check if an argument is a raw vector
assert_scalar Check if an argument is a single atomic value
assert_scalar_na Check if an argument is a single missing value
assert_set_equal Check if an argument is equal to a given set
assert_string Check if an argument is a string
assert_subset Check if an argument is a subset of a given set
assert_tibble Check if an argument is a tibble
assert_true Check if an argument is TRUE
assert_vector Check if an argument is a vector

-- C --

checkAccess Check file system access rights
checkArray Check if an argument is an array
checkAtomic Check that an argument is an atomic vector
checkAtomicVector Check that an argument is an atomic vector
checkCharacter Check if an argument is a vector of type character
checkChoice Check if an object is an element of a given set
checkClass Check the class membership of an argument
checkComplex Check if an argument is a vector of type complex
checkCount Check if an argument is a count
checkDataFrame Check if an argument is a data frame
checkDataTable Check if an argument is a data table
checkDate Check that an argument is a Date
checkDirectory Check for existence and access rights of directories
checkDirectoryExists Check for existence and access rights of directories
checkDisjunct Check if an argument is disjunct from a given set
checkDouble Check that an argument is a vector of type double
checkEnvironment Check if an argument is an environment
checkFactor Check if an argument is a factor
checkFALSE Check if an argument is FALSE
checkFile Check existence and access rights of files
checkFileExists Check existence and access rights of files
checkFlag Check if an argument is a flag
checkFormula Check if an argument is a formula
checkFunction Check if an argument is a function
checkInt Check if an argument is a single integerish value
checkInteger Check if an argument is vector of type integer
checkIntegerish Check if an object is an integerish vector
checkList Check if an argument is a list
checkLogical Check if an argument is a vector of type logical
checkmate checkmate: Fast and Versatile Argument Checks
checkMatrix Check if an argument is a matrix
checkMultiClass Check the class membership of an argument
checkNamed Check if an argument is named
checkNames Check names to comply to specific rules
checkNull Check if an argument is NULL
checkNumber Check if an argument is a single numeric value
checkNumeric Check that an argument is a vector of type numeric
checkOS Check the operating system
checkPathForOutput Check if a path is suited for creating an output file
checkPOSIXct Check that an argument is a date/time object in POSIXct format
checkR6 Check if an argument is a R6 class
checkRaw Check if an argument is a raw vector
checkScalar Check if an argument is a single atomic value
checkScalarNA Check if an argument is a single missing value
checkSetEqual Check if an argument is equal to a given set
checkString Check if an argument is a string
checkSubset Check if an argument is a subset of a given set
checkTibble Check if an argument is a tibble
checkTRUE Check if an argument is TRUE
checkVector Check if an argument is a vector
check_access Check file system access rights
check_array Check if an argument is an array
check_atomic Check that an argument is an atomic vector
check_atomic_vector Check that an argument is an atomic vector
check_character Check if an argument is a vector of type character
check_choice Check if an object is an element of a given set
check_class Check the class membership of an argument
check_complex Check if an argument is a vector of type complex
check_count Check if an argument is a count
check_data_frame Check if an argument is a data frame
check_data_table Check if an argument is a data table
check_date Check that an argument is a Date
check_directory_exists Check for existence and access rights of directories
check_disjunct Check if an argument is disjunct from a given set
check_double Check that an argument is a vector of type double
check_environment Check if an argument is an environment
check_factor Check if an argument is a factor
check_false Check if an argument is FALSE
check_file_exists Check existence and access rights of files
check_flag Check if an argument is a flag
check_formula Check if an argument is a formula
check_function Check if an argument is a function
check_int Check if an argument is a single integerish value
check_integer Check if an argument is vector of type integer
check_integerish Check if an object is an integerish vector
check_list Check if an argument is a list
check_logical Check if an argument is a vector of type logical
check_matrix Check if an argument is a matrix
check_multi_class Check the class membership of an argument
check_named Check if an argument is named
check_names Check names to comply to specific rules
check_null Check if an argument is NULL
check_number Check if an argument is a single numeric value
check_numeric Check that an argument is a vector of type numeric
check_os Check the operating system
check_path_for_output Check if a path is suited for creating an output file
check_posixct Check that an argument is a date/time object in POSIXct format
check_r6 Check if an argument is a R6 class
check_raw Check if an argument is a raw vector
check_scalar Check if an argument is a single atomic value
check_scalar_na Check if an argument is a single missing value
check_set_equal Check if an argument is equal to a given set
check_string Check if an argument is a string
check_subset Check if an argument is a subset of a given set
check_tibble Check if an argument is a tibble
check_true Check if an argument is TRUE
check_vector Check if an argument is a vector

-- E --

expect_access Check file system access rights
expect_array Check if an argument is an array
expect_atomic Check that an argument is an atomic vector
expect_atomic_vector Check that an argument is an atomic vector
expect_character Check if an argument is a vector of type character
expect_choice Check if an object is an element of a given set
expect_class Check the class membership of an argument
expect_complex Check if an argument is a vector of type complex
expect_count Check if an argument is a count
expect_data_frame Check if an argument is a data frame
expect_data_table Check if an argument is a data table
expect_date Check that an argument is a Date
expect_directory Check for existence and access rights of directories
expect_directory_exists Check for existence and access rights of directories
expect_disjunct Check if an argument is disjunct from a given set
expect_double Check that an argument is a vector of type double
expect_environment Check if an argument is an environment
expect_factor Check if an argument is a factor
expect_file Check existence and access rights of files
expect_file_exists Check existence and access rights of files
expect_flag Check if an argument is a flag
expect_formula Check if an argument is a formula
expect_function Check if an argument is a function
expect_int Check if an argument is a single integerish value
expect_integer Check if an argument is vector of type integer
expect_integerish Check if an object is an integerish vector
expect_list Check if an argument is a list
expect_logical Check if an argument is a vector of type logical
expect_matrix Check if an argument is a matrix
expect_multi_class Check the class membership of an argument
expect_names Check names to comply to specific rules
expect_number Check if an argument is a single numeric value
expect_numeric Check that an argument is a vector of type numeric
expect_os Check the operating system
expect_path_for_output Check if a path is suited for creating an output file
expect_posixct Check that an argument is a date/time object in POSIXct format
expect_r6 Check if an argument is a R6 class
expect_raw Check if an argument is a raw vector
expect_scalar Check if an argument is a single atomic value
expect_scalar_na Check if an argument is a single missing value
expect_set_equal Check if an argument is equal to a given set
expect_string Check if an argument is a string
expect_subset Check if an argument is a subset of a given set
expect_tibble Check if an argument is a tibble

-- M --

makeAssertCollection Collect multiple assertions
makeAssertion Turn a Check into an Assertion
makeAssertionFunction Turn a Check into an Assertion
makeExpectation Turn a Check into an Expectation
makeExpectationFunction Turn a Check into an Expectation
makeTest Turn a Check into a Test
makeTestFunction Turn a Check into a Test
matchArg Partial Argument Matching

-- Q --

qassert Quick argument checks on (builtin) R types
qassertr Quick recursive arguments checks on lists and data frames
qexpect Quick argument checks on (builtin) R types
qexpectr Quick recursive arguments checks on lists and data frames
qtest Quick argument checks on (builtin) R types
qtestr Quick recursive arguments checks on lists and data frames

-- R --

register_test_backend Select Backend for Unit Tests
reportAssertions Collect multiple assertions

-- T --

testAccess Check file system access rights
testArray Check if an argument is an array
testAtomic Check that an argument is an atomic vector
testAtomicVector Check that an argument is an atomic vector
testCharacter Check if an argument is a vector of type character
testChoice Check if an object is an element of a given set
testClass Check the class membership of an argument
testComplex Check if an argument is a vector of type complex
testCount Check if an argument is a count
testDataFrame Check if an argument is a data frame
testDataTable Check if an argument is a data table
testDate Check that an argument is a Date
testDirectory Check for existence and access rights of directories
testDirectoryExists Check for existence and access rights of directories
testDisjunct Check if an argument is disjunct from a given set
testDouble Check that an argument is a vector of type double
testEnvironment Check if an argument is an environment
testFactor Check if an argument is a factor
testFALSE Check if an argument is FALSE
testFile Check existence and access rights of files
testFileExists Check existence and access rights of files
testFlag Check if an argument is a flag
testFormula Check if an argument is a formula
testFunction Check if an argument is a function
testInt Check if an argument is a single integerish value
testInteger Check if an argument is vector of type integer
testIntegerish Check if an object is an integerish vector
testList Check if an argument is a list
testLogical Check if an argument is a vector of type logical
testMatrix Check if an argument is a matrix
testMultiClass Check the class membership of an argument
testNamed Check if an argument is named
testNames Check names to comply to specific rules
testNull Check if an argument is NULL
testNumber Check if an argument is a single numeric value
testNumeric Check that an argument is a vector of type numeric
testOS Check the operating system
testPathForOutput Check if a path is suited for creating an output file
testPOSIXct Check that an argument is a date/time object in POSIXct format
testR6 Check if an argument is a R6 class
testRaw Check if an argument is a raw vector
testScalar Check if an argument is a single atomic value
testScalarNA Check if an argument is a single missing value
testSetEqual Check if an argument is equal to a given set
testString Check if an argument is a string
testSubset Check if an argument is a subset of a given set
testTibble Check if an argument is a tibble
testTRUE Check if an argument is TRUE
testVector Check if an argument is a vector
test_access Check file system access rights
test_array Check if an argument is an array
test_atomic Check that an argument is an atomic vector
test_atomic_vector Check that an argument is an atomic vector
test_character Check if an argument is a vector of type character
test_choice Check if an object is an element of a given set
test_class Check the class membership of an argument
test_complex Check if an argument is a vector of type complex
test_count Check if an argument is a count
test_data_frame Check if an argument is a data frame
test_data_table Check if an argument is a data table
test_date Check that an argument is a Date
test_directory Check for existence and access rights of directories
test_directory_exists Check for existence and access rights of directories
test_disjunct Check if an argument is disjunct from a given set
test_double Check that an argument is a vector of type double
test_environment Check if an argument is an environment
test_factor Check if an argument is a factor
test_false Check if an argument is FALSE
test_file_exists Check existence and access rights of files
test_flag Check if an argument is a flag
test_formula Check if an argument is a formula
test_function Check if an argument is a function
test_int Check if an argument is a single integerish value
test_integer Check if an argument is vector of type integer
test_integerish Check if an object is an integerish vector
test_list Check if an argument is a list
test_logical Check if an argument is a vector of type logical
test_matrix Check if an argument is a matrix
test_multi_class Check the class membership of an argument
test_named Check if an argument is named
test_names Check names to comply to specific rules
test_null Check if an argument is NULL
test_number Check if an argument is a single numeric value
test_numeric Check that an argument is a vector of type numeric
test_os Check the operating system
test_path_for_output Check if a path is suited for creating an output file
test_posixct Check that an argument is a date/time object in POSIXct format
test_r6 Check if an argument is a R6 class
test_raw Check if an argument is a raw vector
test_scalar Check if an argument is a single atomic value
test_scalar_na Check if an argument is a single missing value
test_set_equal Check if an argument is equal to a given set
test_string Check if an argument is a string
test_subset Check if an argument is a subset of a given set
test_tibble Check if an argument is a tibble
test_true Check if an argument is TRUE
test_vector Check if an argument is a vector

-- V --

vname Lookup a variable name

-- W --

wf Get the index of the first/last TRUE
wl Get the index of the first/last TRUE

-- misc --

%??% Coalesce operator