check_de_df: Check de data.frame

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

Check de data.frame

Description

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

Usage

check_de_df(de_df)

Arguments

de_df

A data.frame containing information about differentially expressed genes. Must contain the variables: gene Character. The differentially expressed genes. cluster Character. The clusters (or experimental groups) across which the analysis was performed. avg_logFC Numeric. The average log-fold change to which the belonging gene was differentially expressed.. p_val Numeric. The p-values. p_val_adj Numeric. The adjusted p-values. Hint: Use the resulting data.frame of SPATA::findDE() or it's descendants as input.

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.