dot-checkDfValidity: Check if seqinfo DataFrame is valid

In fmicompbio/monaLisa: Binned Motif Enrichment Analysis and Visualization

Check if seqinfo DataFrame is valid

Description

Check if the DataFrame with sequence information is valid, i.e. is of the correct object type (DataFrame) and has all expected columns and attributes.

Usage

.checkDfValidity(df)

Arguments

df

Input object to be checked. It should have an attribute err and columns: seqs : a DNAStringSet object. isForeground that indicates if a sequence is in the foreground group. GCfrac : the fraction of G+C bases per sequence. GCbin : the GC bin for each sequence. GCwgt : the sequence weight to adjust for GC differences between foreground and background sequences. seqWgt : the sequence weight to adjust for k-mer differences between foreground and background sequences.

Value

TRUE (invisibly) if df is valid, otherwise it raises an exception using stop()

fmicompbio/monaLisa documentation built on Nov. 2, 2024, 1:33 p.m.