check_named_list: Check that a list is named

In edwardlavender/fvcom.tbx: An R Toolbox for the Unstructured Grid Finite Volume Community Ocean Model (FVCOM)

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

edwardlavender/fvcom.tbx documentation built on Nov. 26, 2022, 10:28 p.m.