check_smooth: Check smooth input
In kueckelj/SPATA: A Toolbox for Spatial Gene Expression Analysis

check_smooth

R Documentation

Check smooth input

Description

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

Usage

check_smooth(
  df = NULL,
  smooth = NULL,
  smooth_span = NULL,
  smooth_method = NULL,
  smooth_se = NULL
)

Arguments

`df`	A data.frame that is to be smoothed spatially. That data frame must have numeric x- and y-variables.
`smooth`	Logical. If set to TRUE values will be smoothed according to the `smoooth_`-parameters.
`smooth_span`	The amount of smoothing specified as a single numeric value.
`smooth_method`	The smoothing method that will be used specified as a single character value (e.g. "lm", "glm", "gam", "loess").
`smooth_se`	Logical. If set to TRUE the confidence interval will be displayed.

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.