Performs various checks on character vectors, usually names.
checkNames(x, type = "named", subset.of = NULL, must.include = NULL,
permutation.of = NULL, identical.to = NULL, disjunct.from = NULL,
what = "names")check_names(x, type = "named", subset.of = NULL, must.include = NULL,
permutation.of = NULL, identical.to = NULL, disjunct.from = NULL,
what = "names")
assertNames(x, type = "named", subset.of = NULL, must.include = NULL,
permutation.of = NULL, identical.to = NULL, disjunct.from = NULL,
what = "names", .var.name = vname(x), add = NULL)
assert_names(x, type = "named", subset.of = NULL,
must.include = NULL, permutation.of = NULL, identical.to = NULL,
disjunct.from = NULL, what = "names", .var.name = vname(x),
add = NULL)
testNames(x, type = "named", subset.of = NULL, must.include = NULL,
permutation.of = NULL, identical.to = NULL, disjunct.from = NULL,
what = "names")
test_names(x, type = "named", subset.of = NULL, must.include = NULL,
permutation.of = NULL, identical.to = NULL, disjunct.from = NULL,
what = "names")
expect_names(x, type = "named", subset.of = NULL,
must.include = NULL, permutation.of = NULL, identical.to = NULL,
disjunct.from = NULL, what = "names", info = NULL,
label = vname(x))
[character
|| NULL
]
Names to check using rules defined via type
.
[character(1)] Type of formal check(s) to perform on the names.
Checks x
to be NULL
.
Checks x
for regular names which excludes names to be NA
or empty (""
).
Performs checks like with “named” and additionally tests for non-duplicated names.
Performs checks like with “unique” and additionally fails for names with UTF-8 characters and names which do not comply to R's variable name restrictions. As regular expression, this is “^[.]*[a-zA-Z]+[a-zA-Z0-9._]*$”.
Same as “strict”, but does not enforce uniqueness.
Note that for zero-length x
, all these name checks evaluate to TRUE
.
[character
]
Names provided in x
must be subset of the set subset.of
.
[character
]
Names provided in x
must be a superset of the set must.include
.
[character
]
Names provided in x
must be a permutation of the set permutation.of
.
Duplicated names in permutation.of
are stripped out and duplicated names in x
thus lead to a failed check.
Use this argument instead of identical.to
if the order of the names is not relevant.
[character
]
Names provided in x
must be identical to the vector identical.to
.
Use this argument instead of permutation.of
if the order of the names is relevant.
[character
]
Names provided in x
must may not be present in the vector identical.to
.
[character(1)
]
Type of name vector to check, e.g. “names” (default), “colnames” or “rownames”.
[character(1)
]
Name of the checked object to print in assertions. Defaults to
the heuristic implemented in vname
.
[AssertCollection
]
Collection to store assertion messages. See AssertCollection
.
[character(1)]
Extra information to be included in the message for the testthat reporter.
See expect_that
.
[character(1)
]
Name of the checked object to print in messages. Defaults to
the heuristic implemented in vname
.
Depending on the function prefix:
If the check is successful, the functions
assertNamed
/assert_named
return
x
invisibly, whereas
checkNamed
/check_named
and
testNamed
/test_named
return
TRUE
.
If the check is not successful,
assertNamed
/assert_named
throws an error message,
testNamed
/test_named
returns FALSE
,
and checkNamed
returns a string with the error message.
The function expect_named
always returns an
expectation
.
Other attributes: checkClass
,
checkMultiClass
, checkNamed
# NOT RUN {
x = 1:3
testNames(x, "unnamed")
names(x) = letters[1:3]
testNames(x, "unique")
cn = c("Species", "Sepal.Length", "Sepal.Width", "Petal.Length", "Petal.Width")
assertNames(names(iris), permutation.of = cn)
# }
Run the code above in your browser using DataCamp Workspace