check_pt: Check pt input

In kueckelj/SPATA: A Toolbox for Spatial Gene Expression Analysis

Check pt input

Description

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

Usage

check_pt(
  pt_size = NULL,
  pt_alpha = NULL,
  pt_clrsp = NULL,
  pt_clrsp_dir = NULL,
  pt_clrp = NULL,
  pt_clr = NULL
)

Arguments

pt_size	The size of the points specified as a single numeric value.
pt_alpha	The transparency of the points specified as single numeric value.
pt_clrsp	The color spectrum to be used if the specified variable displayed by color is continuous. Run all_colorspectra() to see valid input..
pt_clrsp_dir	The direction of the color spectrum specified as either 1 or -1.
pt_clrp	The color panel to be used if the specified variable displayed by color is categorical/discrete. Run all_colorpanels() to see valid input.
pt_clr	The base color of every point displayed in 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.