check_list_of_lists: Check list of lists

View source: R/check_list_of_lists.R

check_list_of_listsR Documentation

Check list of lists

Description

These functions check whether the input is a list that contains list elements.

Usage

check_list_of_lists(x, len = NULL)

assert_list_of_lists(
  x,
  len = NULL,
  .var.name = checkmate::vname(x),
  add = NULL
)

test_list_of_lists(x, len = NULL)

Arguments

x

[any]
Object to check.

len

[integer(1)]
Exact expected length of x.

.var.name

[character(1)]
Name of the checked object to print in assertions. Defaults to the heuristic implemented in vname.

add

[AssertCollection]
Collection to store assertion messages. See AssertCollection.

Value

Same as documented in check_list.

See Also

Other list helpers: merge_lists()

Examples

L <- list(list(1), list(2), 3)
check_list_of_lists(L)
test_list_of_lists(L)
## Not run: 
assert_list_of_lists(L)

## End(Not run)

oeli documentation built on Oct. 16, 2024, 5:08 p.m.