Build a synthetic enhanceosome result for use in examples
Source:R/synthetic-data.R
make_example_enhanceosome.RdReturns an epiRomicsS4 object whose annotations slot holds a
synthetic enhanceosome GRanges with the same column structure as the
output of find_enhanceosomes (one integer count column per
ChIP TF in the meta() table of database, plus a
ChIP_Hits total column).
Arguments
- database
An
epiRomicsS4object, orNULL(default). WhenNULL,make_example_databaseis called internally.
Details
The result is built directly from in-memory structures (no ChIPseeker
annotation, no TxDb lookup) so the example completes in under one second
under R CMD check. It is fit-for-purpose for exercising the
enhanceosome-consuming functions
(analyze_tf_cobinding, analyze_tf_overlap, etc.)
without the cost of the full enhancer-calling pipeline.
See also
make_example_database,
find_enhanceosomes
Other synthetic example data helpers:
make_example_bigwig(),
make_example_database(),
make_example_putative_enhancers()
Examples
eso <- make_example_enhanceosome()
length(annotations(eso))
#> [1] 3