chk_indices: Check Indices

View source: R/chk-indices.R

chk_indicesR Documentation

Check Indices

Description

Checks if an object is a list of indices ie vectors of one or more positive integer values.

Usage

chk_indices(x, x_name = NULL)

vld_indices(x)

Arguments

x

An object.

x_name

A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails.

The vld_ function returns a flag indicating whether the test was met.

Functions

  • vld_indices(): Validate Indices

Examples

x <- list(c(2L, 1L))
chk_indices(x)
y <- c(2L, 1L)
try(chk_indices(y))
vld_indices(c(3L, 1L))
vld_indices(list(c(3L, 1L)))

extras documentation built on May 31, 2023, 6:22 p.m.