HiC processing report

HiCReport(x, output = NULL)

Arguments

x: an CoolFile object, generated from HiCool::HiCool() or HiCool::importHiCoolFolder(), or directly from calling HiCExperiment::CoolFile().
output: Path to save output HTML file.

Value

String to the generated HTML report file

Examples

mcool_path <- HiContactsData::HiContactsData('yeast_wt', 'mcool')
#> see ?HiContactsData and browseVignettes('HiContactsData') for documentation
#> loading from cache
pairs_path <- HiContactsData::HiContactsData('yeast_wt', 'pairs.gz')
#> see ?HiContactsData and browseVignettes('HiContactsData') for documentation
#> loading from cache
log_path <- HiContactsData::HiContactsData(sample = 'yeast_wt', format = 'HiCool_log')
#> see ?HiContactsData and browseVignettes('HiContactsData') for documentation
#> loading from cache
cf <- CoolFile(mcool_path, pairs = pairs_path, metadata = list(log = log_path))
HiCReport(cf)
#> HiCool :: Report generated and available @ /github/home/.cache/R/1ee414121583_7752.html
#> [1] "/github/home/.cache/R/1ee414121583_7752.html"