check_assign: Check assign input

In kueckelj/confuns: Convenience Functions

Check assign input

Description

A member of the lazy-check_*()-family.

Usage

check_assign(assign = FALSE, assign_name = character(1))

Arguments

assign	Logical. If set to TRUE a named list will be assigned to the global environment. This list contains data and information to rebuild or additionally customize the output plot of this function.
assign_name	The name the assigned list is supposed to have specified as a single character value.

Details

Members of the lazy-check_*()-family take the arguments of their kind - that are used in the function they are called in - and checks whether these arguments input fit the requirements. They stop and return an error immediately once they stumble upon something invalid. They do not alter or adjust input and return TRUE if the whole function has been executed without anything invalid being found.

Value

A logical value TRUE if nothing invalid has been detected or an informative feedback message.

kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.