# Fast and Versatile Argument Checks

## Documentation for package ‘checkmate’ version 1.6.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C Q T

checkmate-package | The checkmate package

## -- A --

allMissing | Check if an object contains missing values
anyInfinite | Check if an object contains infinte values
anyMissing | Check if an object contains missing 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 argument inheritance
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
assertDirectory | Check for existence and access rights of directories
assertEnvironment | Check if an argument is an environment
assertFactor | Check if an argument is a factor
assertFile | Check existence and access rights of files
assertFlag | Check if an argument is a flag
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
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
assertNumeric | Check that an argument is a vector of type numeric
assertPathForOutput | Check file path for later output
assertPercentage | Check if an argument is a percentage
assertScalar | Check if an argument is a single atomic value
assertScalarNA | Check if an argument is a single missing value
assertSetEqual | Check if object is a subset of a given set
assertString | Check if an argument is a string
assertSubset | Check if object is a subset of a given set
assertVector | 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 argument inheritance
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
checkDirectory | Check for existence and access rights of directories
checkEnvironment | Check if an argument is an environment
checkFactor | Check if an argument is a factor
checkFile | Check existence and access rights of files
checkFlag | Check if an argument is a flag
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 | The checkmate package
checkMatrix | Check if an argument is a matrix
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
checkNumeric | Check that an argument is a vector of type numeric
checkPathForOutput | Check file path for later output
checkPercentage | Check if an argument is a percentage
checkScalar | Check if an argument is a single atomic value
checkScalarNA | Check if an argument is a single missing value
checkSetEqual | Check if object is a subset of a given set
checkString | Check if an argument is a string
checkSubset | Check if object is a subset of a given set
checkVector | Check if an argument is a vector

## -- Q --

qassert | Quick argument checks on (builtin) R types
qassertr | 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

## -- 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 argument inheritance
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
testDirectory | Check for existence and access rights of directories
testEnvironment | Check if an argument is an environment
testFactor | Check if an argument is a factor
testFile | Check existence and access rights of files
testFlag | Check if an argument is a flag
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
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
testNumeric | Check that an argument is a vector of type numeric
testPathForOutput | Check file path for later output
testPercentage | Check if an argument is a percentage
testScalar | Check if an argument is a single atomic value
testScalarNA | Check if an argument is a single missing value
testSetEqual | Check if object is a subset of a given set
testString | Check if an argument is a string
testSubset | Check if object is a subset of a given set
testVector | Check if an argument is a vector