check_trajectory: Check trajectory name input

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

check_trajectoryR Documentation

Check trajectory name input

Description

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

Usage

check_trajectory(object, trajectory_name, of_sample)

Arguments

object

A valid spata-object.

trajectory_name

The trajectory of interest specified as a single character value.

of_sample

The sample(s) of interest specified as a single character value or vector. If set to "" (the default) the first sample is chosen.

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.