check_ncol: Check Number of Columns

In poissonconsulting/checkr: Check the Properties of Common R Objects

Check Number of Columns

Description

Checks the number of columns of a data frame.

Usage

check_ncol(x, ncol = TRUE, x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
ncol	A flag indicating whether x should have columns (versus no columns) or a missing value indicating no requirements or a count or count range of the number of columns.
x_name	A string of the name of the object x.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_nrow and check_data

Examples

check_ncol(data.frame(x = 1), error = FALSE)
check_ncol(data.frame(x = 1:2), ncol = 1, error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.