gi_list_validate: gi_list_validate

View source: R/gi_list_validate.R

gi_list_validateR Documentation

gi_list_validate

Description

This function validates a gi_list instance.

Usage

gi_list_validate(gi_list)

Arguments

gi_list

gi_list object to be verified. In order to pass without errors, a gi_list object (1) has to be a list of InteractionSet::GInteractions objects, (2) each list element has to be named as chromosomes and only contain intra-chromosomal interaction information, (3) mcols(.) for each list element should at least contain pairwise genomic distances in a column named 'D'.

Value

invisible value if the gi_list instance is valid. Otherwise, an error is raised.

Examples

gi_list<-generate_binned_gi_list(1e6,chrs='chr22')
gi_list_validate(gi_list)

mervesa/HiCDCPlus documentation built on June 8, 2022, 3:43 a.m.