Assertive Check Functions


[Up] [Top]

Documentation for package ‘goalie’ version 0.4.4

Help Pages

A C F H I M N P S V

-- A --

allAreAtomic Does the input contain elements that are all atomic?
allAreCompressedFiles Does the input contain a compressed file?
allAreDirectories Does the input contain a directory?
allAreDirs Does the input contain a directory?
allAreEqualTo How does the input relate to a value?
allAreExisting Does the requested input exist in the environment?
allAreFiles Does the input contain a file?
allAreGreaterThan How does the input relate to a value?
allAreGreaterThanOrEqualTo How does the input relate to a value?
allAreHexColors Does the input contain hexadecimal colors?
allAreInClosedRange Is the input in range?
allAreInLeftOpenRange Is the input in range?
allAreInOpenRange Is the input in range?
allAreInRange Is the input in range?
allAreInRightOpenRange Is the input in range?
allAreInstalled Is the package installed?
allAreLessThan How does the input relate to a value?
allAreLessThanOrEqualTo How does the input relate to a value?
allAreMatchingFixed Does the string match a pattern?
allAreMatchingRegex Does the string match a pattern?
allAreNegative Is the input in range?
allAreNonExisting Does the requested input exist in the environment?
allAreNonNegative Is the input in range?
allAreNonPositive Is the input in range?
allAreNotEqualTo How does the input relate to a value?
allAreNotMatchingFixed Does the string match a pattern?
allAreNotMatchingRegex Does the string match a pattern?
allArePercentage Is the input in range?
allArePositive Is the input in range?
allAreProportion Is the input in range?
allAreSystemCommands Does the string match a pattern?
allAreURLs Does the input contain a URL?
allHaveAccess Check file system access rights
areDisjointSets Set comparisons
areIntersectingSets Set comparisons
areSameLength Do the inputs have the same length?
areSetEqual Set comparisons
assert Assert that certain conditions are true

-- C --

cause Get or set the 'cause' attribute
cause<- Get or set the 'cause' attribute
check-scalar-allAreAtomic Does the input contain elements that are all atomic?
check-scalar-areSameLength Do the inputs have the same length?
check-scalar-formalCompress Check the 'compress' formal argument
check-scalar-hasDimnames Does the input have dimnames?
check-scalar-hasDims Does the input have dimensions?
check-scalar-hasDuplicates Does the input have duplicates?
check-scalar-hasElements Does the input have elements?
check-scalar-hasGitHubPAT Does the current session have a GitHub personal access token?
check-scalar-hasInternet Does the current session have an internet connection?
check-scalar-hasLength Does the input have a non-zero or defined length?
check-scalar-hasMetrics Does the object contain quality control metrics?
check-scalar-hasNames Does the input have names?
check-scalar-hasNonzeroRowsAndCols Does the input contain non-zero rows and columns?
check-scalar-hasRownames Does the input have row names?
check-scalar-hasSubset Does the object contain a subset of data?
check-scalar-hasUniqueCols Does the input have columns with unique values?
check-scalar-hasValidNames Does the input object have syntactically valid names?
check-scalar-isAll Does the input belong to or inherit all of these classes?
check-scalar-isAlpha Does the input contain an alpha level?
check-scalar-isAny Does the object belong to or inherit any of these classes?
check-scalar-isCharacter Does the input contain a (non-empty) character vector?
check-scalar-isDocker Is the R session running inside Docker?
check-scalar-isFileSystemCaseSensitive Is the file system case sensitive?
check-scalar-isFlag Does the input contain a boolean flag?
check-scalar-isGGScale Does the input contain a ggplot2 scale?
check-scalar-isHeaderLevel Does the input contain a Markdown header level?
check-scalar-isHexColorFunction Does the argument contain a function that returns hexadecimal colors?
check-scalar-isLinux Is the operating system Linux?
check-scalar-isMacOS Is the operating system macOS?
check-scalar-isOfDimension Does the input contain specific dimensions?
check-scalar-isRStudio Is the current R session running inside RStudio?
check-scalar-isScalar Is the input scalar?
check-scalar-isString Does the input contain a (non-empty) character string?
check-scalar-isUnix Is the operating system Unix-based?
check-scalar-isWindows Is the operating system Windows?
check-scalar-matchesUniqueGeneNames Do the input gene names match unique values in the corresponding object?
check-scalar-sets Set comparisons
check-scalar-validNames Are these valid names?
check-vector-hasAccess Check file system access rights
check-vector-isCompressedFile Does the input contain a compressed file?
check-vector-isDirectory Does the input contain a directory?
check-vector-isEqual How does the input relate to a value?
check-vector-isExisting Does the requested input exist in the environment?
check-vector-isFile Does the input contain a file?
check-vector-isHexColor Does the input contain hexadecimal colors?
check-vector-isInRange Is the input in range?
check-vector-isInstalled Is the package installed?
check-vector-isIntegerish Is the input integer(ish)?
check-vector-isMatching Does the string match a pattern?
check-vector-isSystemCommand Is a system command installed?
check-vector-isURL Does the input contain a URL?

-- F --

formalCompress Check the 'compress' formal argument

-- H --

hasAccess Check file system access rights
hasColnames Does the input have dimnames?
hasCols Does the input have dimensions?
hasDimnames Does the input have dimnames?
hasDims Does the input have dimensions?
hasDuplicates Does the input have duplicates?
hasElements Does the input have elements?
hasGitHubPAT Does the current session have a GitHub personal access token?
hasInternet Does the current session have an internet connection?
hasLength Does the input have a non-zero or defined length?
hasMetrics Does the object contain quality control metrics?
hasNames Does the input have names?
hasNoDuplicates Does the input have duplicates?
hasNonzeroRowsAndCols Does the input contain non-zero rows and columns?
hasRownames Does the input have row names?
hasRows Does the input have dimensions?
hasSubset Does the object contain a subset of data?
hasUniqueCols Does the input have columns with unique values?
hasValidDimnames Does the input object have syntactically valid names?
hasValidNames Does the input object have syntactically valid names?

-- I --

isACompressedFile Does the input contain a compressed file?
isADir Does the input contain a directory?
isADirectory Does the input contain a directory?
isAFile Does the input contain a file?
isAll Does the input belong to or inherit all of these classes?
isAlpha Does the input contain an alpha level?
isAny Does the object belong to or inherit any of these classes?
isAURL Does the input contain a URL?
isCharacter Does the input contain a (non-empty) character vector?
isCompressedFile Does the input contain a compressed file?
isDir Does the input contain a directory?
isDirectory Does the input contain a directory?
isDocker Is the R session running inside Docker?
isEqualTo How does the input relate to a value?
isExisting Does the requested input exist in the environment?
isFile Does the input contain a file?
isFileSystemCaseSensitive Is the file system case sensitive?
isFlag Does the input contain a boolean flag?
isGGScale Does the input contain a ggplot2 scale?
isGreaterThan How does the input relate to a value?
isGreaterThanOrEqualTo How does the input relate to a value?
isHeaderLevel Does the input contain a Markdown header level?
isHexColor Does the input contain hexadecimal colors?
isHexColorFunction Does the argument contain a function that returns hexadecimal colors?
isInClosedRange Is the input in range?
isInLeftOpenRange Is the input in range?
isInOpenRange Is the input in range?
isInRange Is the input in range?
isInRightOpenRange Is the input in range?
isInstalled Is the package installed?
isInt Is the input integer(ish)?
isIntegerish Is the input integer(ish)?
isLessThan How does the input relate to a value?
isLessThanOrEqualTo How does the input relate to a value?
isLinux Is the operating system Linux?
isMacOS Is the operating system macOS?
isMatchingFixed Does the string match a pattern?
isMatchingRegex Does the string match a pattern?
isNegative Is the input in range?
isNonExisting Does the requested input exist in the environment?
isNonNegative Is the input in range?
isNonPositive Is the input in range?
isNonScalar Is the input scalar?
isNotEqualTo How does the input relate to a value?
isNotMatchingFixed Does the string match a pattern?
isNotMatchingRegex Does the string match a pattern?
isNumber Is the input scalar?
isOfDimension Does the input contain specific dimensions?
isPercentage Is the input in range?
isPositive Is the input in range?
isProportion Is the input in range?
isRStudio Is the current R session running inside RStudio?
isScalar Is the input scalar?
isScalarAtomic Is the input scalar?
isScalarCharacter Is the input scalar?
isScalarDouble Is the input scalar?
isScalarInteger Is the input scalar?
isScalarIntegerish Is the input scalar?
isScalarList Is the input scalar?
isScalarLogical Is the input scalar?
isScalarNumeric Is the input scalar?
isScalarVector Is the input scalar?
isString Does the input contain a (non-empty) character string?
isSubset Set comparisons
isSuperset Set comparisons
isSystemCommand Is a system command installed?
isUnix Is the operating system Unix-based?
isURL Does the input contain a URL?
isWindows Is the operating system Windows?

-- M --

matchesUniqueGeneNames Do the input gene names match unique values in the corresponding object?

-- N --

nElements Does the input have elements?
nocause Get or set the 'cause' attribute

-- P --

print Print methods for objects with a cause attribute
print.goalie Print methods for objects with a cause attribute

-- S --

skip_on_docker Is the R session running inside Docker?

-- V --

validate Validate an S4 class
validateClasses Validate expected classes
validNames Are these valid names?