check_stdf: Check summarized trajectory data.frame

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

check_stdfR Documentation

Check summarized trajectory data.frame

Description

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

Usage

check_stdf(stdf)

Arguments

stdf

A data.frame containing information about a spatial trajectory. Must contain the variables:

trajectory_part

Character. The trajectory's subparts.

trajectory_part_order

Numeric. Denotes every trajectory-bin's position along the trajectory's subpart.

trajectory_order

Numeric. Denotes every trajectory-bin's position along the whole trajectory.

variables

Character. The genes, gene-sets and features that have been summarized along the trajectory.

values

Numeric. The binned values of every gene, gene-set and feature that has been summarized along the trajectory.

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.