check_nrow: Check Number of Rows

View source: R/nrow.R

check_nrowR Documentation

Check Number of Rows

Description

Checks the number of rows of a data frame.

Usage

check_nrow(x, nrow = TRUE, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

nrow

A flag indicating whether x should have rows (versus no rows) or a missing value indicating no requirements or a count or count range of the number of rows.

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

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.

See Also

check_ncol and check_data

Examples

check_nrow(data.frame(x = 1), error = FALSE)
check_nrow(data.frame(x = integer(0)), error = FALSE)
check_nrow(data.frame(x = 1:2), nrow = 1, error = FALSE)

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