Assertive Check Functions
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘goalie’ version 0.7.5
Help Pages
-- A --
| allAreAtomic | Does the input contain elements that are all atomic? |
| allAreAwsS3Uris | Does the input contain an AWS S3 URI? |
| 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? |
| allAreExistingAwsS3Uris | Does the input contain an existing (active) AWS S3 URI? |
| allAreExistingUrls | Does the input contain an existing (active) URL? |
| allAreFiles | Does the input contain a file? |
| allAreGitRepos | Does the input contain a Git repository? |
| 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? |
| allAreIntegerish | Is the input integer(ish)? |
| 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? |
| allAreSymlinks | Does the input contain a symbolic link? |
| allAreSystemCommands | Does the string match a pattern? |
| allAreTempFiles | Does the input contain a temporary file (that exists on disk)? |
| 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 |
-- B --
| bapply | Boolean apply |
-- C --
| cause | Cause attribute |
| cause-method | 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-hasClusters | Does the input object contain clusters? |
| check-scalar-hasCpu | Does the current machine have a sufficient number of CPU cores? |
| 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-hasMultipleSamples | Does the input object contain multiple samples? |
| check-scalar-hasNames | Does the input have names? |
| check-scalar-hasNonzeroRowsAndCols | Does the input contain non-zero rows and columns? |
| check-scalar-hasRam | Does the current machine have a sufficient RAM? |
| 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-isBiocDevel | Is the current Bioconductor installation under development? |
| check-scalar-isBiocParallelParam | Does the input contain a BiocParallel parameter? |
| check-scalar-isCharacter | Does the input contain a (non-empty) character vector? |
| check-scalar-isCleanSystemLibrary | Is the R system library clean? |
| check-scalar-isCondaEnabled | Is conda enabled (active) in the current R session? |
| check-scalar-isDark | Is dark mode preferred? |
| check-scalar-isDevel | Is the current session running inside R-devel? |
| check-scalar-isDocker | Is the R session running inside Docker? |
| check-scalar-isDockerEnabled | Is Docker enabled (running) on the current machine? |
| 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-isOrganism | Is the string input a full Latin organism name? |
| 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-isTximport | Does the input contain a tximport list? |
| check-scalar-isUnix | Is the operating system Unix-based? |
| check-scalar-isVanilla | Is the R session running as vanilla? |
| check-scalar-isVectorish | Is the input vector(ish)? |
| check-scalar-isVscode | Is the current R session running inside Visual Studio Code? |
| 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-isAwsS3Uri | Does the input contain an AWS S3 URI? |
| check-vector-isCompressedFile | Does the input contain a compressed file? |
| check-vector-isDirectory | Does the input contain a directory? |
| check-vector-isDuplicate | Does the input contain a duplicate value? |
| check-vector-isEqual | How does the input relate to a value? |
| check-vector-isExisting | Does the requested input exist in the environment? |
| check-vector-isExistingAwsS3Uri | Does the input contain an existing (active) AWS S3 URI? |
| check-vector-isExistingUrl | Does the input contain an existing (active) URL? |
| check-vector-isFile | Does the input contain a file? |
| check-vector-isGitRepo | Does the input contain a Git repository? |
| 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-isPackageVersion | Is the package installed and a specific version? |
| check-vector-isSymlink | Does the input contain a symbolic link? |
| check-vector-isSystemCommand | Is a system command installed? |
| check-vector-isTempFile | Does the input contain a temporary file (that exists on disk)? |
| check-vector-isUrl | Does the input contain a URL? |
-- F --
| false | Set a false goalie check with cause attribute |
| falseFromVector | Set a scalar false goalie check with cause attribute |
| falseFromVector-method | Set a scalar false goalie check with cause attribute |
| formalCompress | Check the 'compress' formal argument |
-- G --
| goalie | Define a goalie check classed return |
| goalie-class | goalie logical assert check return |
-- H --
| hasAccess | Check file system access rights |
| hasClusters | Does the input object contain clusters? |
| hasColnames | Does the input have dimnames? |
| hasCols | Does the input have dimensions? |
| hasCpu | Does the current machine have a sufficient number of CPU cores? |
| 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? |
| hasMultipleSamples | Does the input object contain multiple samples? |
| hasNames | Does the input have names? |
| hasNoDuplicates | Does the input have duplicates? |
| hasNonzeroRowsAndCols | Does the input contain non-zero rows and columns? |
| hasRam | Does the current machine have a sufficient RAM? |
| 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? |
| isAGitRepo | Does the input contain a Git repository? |
| isAll | Does the input belong to or inherit all of these classes? |
| isAlpha | Does the input contain an alpha level? |
| isAnAwsS3Uri | Does the input contain an AWS S3 URI? |
| isAnExistingAwsS3Uri | Does the input contain an existing (active) AWS S3 URI? |
| isAnExistingUrl | Does the input contain an existing (active) URL? |
| isAny | Does the object belong to or inherit any of these classes? |
| isASymlink | Does the input contain a symbolic link? |
| isASystemCommand | Is a system command installed? |
| isATempFile | Does the input contain a temporary file (that exists on disk)? |
| isAUrl | Does the input contain a URL? |
| isAwsS3Uri | Does the input contain an AWS S3 URI? |
| isBiocDevel | Is the current Bioconductor installation under development? |
| isBiocParallelParam | Does the input contain a BiocParallel parameter? |
| isCharacter | Does the input contain a (non-empty) character vector? |
| isCleanSystemLibrary | Is the R system library clean? |
| isCompressedFile | Does the input contain a compressed file? |
| isCondaEnabled | Is conda enabled (active) in the current R session? |
| isDark | Is dark mode preferred? |
| isDevel | Is the current session running inside R-devel? |
| isDir | Does the input contain a directory? |
| isDirectory | Does the input contain a directory? |
| isDocker | Is the R session running inside Docker? |
| isDockerEnabled | Is Docker enabled (running) on the current machine? |
| isDuplicate | Does the input contain a duplicate value? |
| isEqualTo | How does the input relate to a value? |
| isExisting | Does the requested input exist in the environment? |
| isExistingAwsS3Uri | Does the input contain an existing (active) AWS S3 URI? |
| isExistingUrl | Does the input contain an existing (active) URL? |
| 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? |
| isGitRepo | Does the input contain a Git repository? |
| 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? |
| isOrganism | Is the string input a full Latin organism name? |
| isPackageVersion | Is the package installed and a specific version? |
| 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 |
| isSymlink | Does the input contain a symbolic link? |
| isSystemCommand | Is a system command installed? |
| isTempFile | Does the input contain a temporary file (that exists on disk)? |
| isTximport | Does the input contain a tximport list? |
| isUnix | Is the operating system Unix-based? |
| isUrl | Does the input contain a URL? |
| isVanilla | Is the R session running as vanilla? |
| isVectorish | Is the input vector(ish)? |
| isVscode | Is the current R session running inside Visual Studio Code? |
| 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 | Return standard logical without cause attribute |
| nocause-method | Return standard logical without cause attribute |
-- Q --
| quietly | Perform an action quietly |
-- R --
| requireNamespaces | Require package namespaces |
-- S --
| setCause | Return 'FALSE' vector with causes of failure |
| setCause-method | Return 'FALSE' vector with causes of failure |
| show | Show an object |
| show-method | Show an object |
-- V --
| validate | Validate an S4 class |
| validateClasses | Validate expected classes |
| validNames | Are these valid names? |