1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/zzz.R
\docType{package}
\name{checkmate-package}
\alias{checkmate}
\alias{checkmate-package}
\title{checkmate: Fast and Versatile Argument Checks}
\description{
Tests and assertions to perform frequent argument checks. A substantial part of the package was written in C to minimize any worries about execution time overhead.
}
\section{Check scalars}{
\itemize{
\item{\code{\link{checkFlag}}}
\item{\code{\link{checkCount}}}
\item{\code{\link{checkNumber}}}
\item{\code{\link{checkInt}}}
\item{\code{\link{checkString}}}
\item{\code{\link{checkScalar}}}
\item{\code{\link{checkScalarNA}}}
}
}
\section{Check vectors}{
\itemize{
\item{\code{\link{checkLogical}}}
\item{\code{\link{checkNumeric}}}
\item{\code{\link{checkDouble}}}
\item{\code{\link{checkInteger}}}
\item{\code{\link{checkIntegerish}}}
\item{\code{\link{checkCharacter}}}
\item{\code{\link{checkComplex}}}
\item{\code{\link{checkFactor}}}
\item{\code{\link{checkList}}}
\item{\code{\link{checkPOSIXct}}}
\item{\code{\link{checkVector}}}
\item{\code{\link{checkAtomic}}}
\item{\code{\link{checkAtomicVector}}}
\item{\code{\link{checkRaw}}}
}
}
\section{Check attributes}{
\itemize{
\item{\code{\link{checkClass}}}
\item{\code{\link{checkMultiClass}}}
\item{\code{\link{checkNames}}}
\item{\code{\link{checkNamed}}} (deprecated)
}
}
\section{Check compound types}{
\itemize{
\item{\code{\link{checkArray}}}
\item{\code{\link{checkDataFrame}}}
\item{\code{\link{checkMatrix}}}
}
}
\section{Check other built-in R types}{
\itemize{
\item{\code{\link{checkDate}}}
\item{\code{\link{checkEnvironment}}}
\item{\code{\link{checkFunction}}}
\item{\code{\link{checkFormula}}}
\item{\code{\link{checkNull}}}
}
}
\section{Check sets}{
\itemize{
\item{\code{\link{checkChoice}}}
\item{\code{\link{checkSubset}}}
\item{\code{\link{checkSetEqual}}}
\item{\code{\link{checkDisjunct}}}
\item{\code{\link{checkPermutation}}}
}
}
\section{File IO}{
\itemize{
\item{\code{\link{checkFileExists}}}
\item{\code{\link{checkDirectoryExists}}}
\item{\code{\link{checkPathForOutput}}}
\item{\code{\link{checkAccess}}}
}
}
\section{Popular data types of third party packages}{
\itemize{
\item{\code{\link{checkDataTable}}}
\item{\code{\link{checkR6}}}
\item{\code{\link{checkTibble}}}
}
}
\section{Safe coercion to integer}{
\itemize{
\item{\code{\link{asCount}}}
\item{\code{\link{asInt}}}
\item{\code{\link{asInteger}}}
}
}
\section{Quick argument checks using a DSL}{
\itemize{
\item{\code{\link{qassert}}}
\item{\code{\link{qassertr}}}
}
}
\section{Misc}{
\itemize{
\item{\code{\link{checkOS}} (check operating system)}
\item{\code{\link{assert}} (combine multiple checks into an assertion)}
\item{\code{\link{anyMissing}}}
\item{\code{\link{allMissing}}}
\item{\code{\link{anyNaN}}}
\item{\code{\link{wf}} (which.first and which.last)}
}
}
\seealso{
Useful links:
\itemize{
\item \url{https://mllg.github.io/checkmate/}
\item \url{https://github.com/mllg/checkmate}
\item Report bugs at \url{https://github.com/mllg/checkmate/issues}
}
}
\author{
\strong{Maintainer}: Michel Lang \email{michellang@gmail.com} (\href{https://orcid.org/0000-0001-9754-0393}{ORCID})
Other contributors:
\itemize{
\item Bernd Bischl \email{bernd_bischl@gmx.net} [contributor]
\item Dénes Tóth \email{toth.denes@kogentum.hu} (\href{https://orcid.org/0000-0003-4262-3217}{ORCID}) [contributor]
}
}
|
