check_atdf: Check assessed trajectory data.frame

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

check_atdfR Documentation

Check assessed trajectory data.frame

Description

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

Usage

check_atdf(atdf)

check_rtdf(rtdf, variable = NULL)

Arguments

atdf

A data.frame containing the results of trajectory-modelling. Must contain the variables:

variables

Character. The genes, gene-sets and features that have been assessed.

pattern

Character. The respective trajectory pattern.

auc

Numeric. The assessment value which is the residual's area under the curve.

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.