check_named_list: Check that a list is named

In edwardlavender/flapper: Routines for the Analysis of Passive Acoustic Telemetry Data

Check that a list is named

Description

This function checks that the top level of a list is named (ignoring empty lists if requested). If the list is not named, the function returns a helpful error message. Otherwise, the list is returned unchanged. This is particularly useful within functions that use do.call to evaluate lists of arguments.

Usage

check_named_list(arg = deparse(substitute(input)), input, ignore_empty = TRUE)

Arguments

arg	(optional) A character string which defines the argument of a parent function.
input	A list.
ignore_empty	A logical input which defines whether or not to ignore empty lists.

Value

The function returns a helpful error message for unnamed lists (ignoring empty lists if requested) or the inputted list unchanged.

Author(s)

Edward Lavender

Source

This function is taken from the ‘utils.add’ package (https://github.com/edwardlavender/utils.add). It is defined separately in flapper to reduce reliance on non-default packages.

edwardlavender/flapper documentation built on Jan. 22, 2025, 2:44 p.m.