check_display: Check display input

View source: R/check-family-lazy.R

check_displayR Documentation

Check display input

Description

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

Usage

check_display(display_title = FALSE, display_image = FALSE)

Arguments

display_title

Logical. If set to TRUE an informative title is displayed.

display_image

Logical. If set to TRUE the histology image of the specified sample is displayed underneath the plot.

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 error message.


kueckelj/SPATA documentation built on March 22, 2022, 9:59 p.m.