README.md

Travis CI: Build Status

My Image

HiCBricks

HiCBricks is a R/Bioconductor package for handling high-resolution Hi-C datasets through HDF (Hierarchical Data Format) files. Read more about HDF here

Features

Installation

To install the most stable development version from Bioconductor, run this from a R console. Note: R version >= 3.5 is required. This command will first installs BiocManager from CRAN. BiocManager is a convenient utility to install Bioconductor packages. Then, we install HiCBricks through BiocManager.

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("HiCBricks", version = "3.11")

To install the stable release version from Bioconductor, run this from a R console.

if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("HiCBricks", version = "3.11")

To install the most cutting-edge stable version of HiCBricks, do this from a R console to download it directly from GitHub.

if (!requireNamespace("devtools", quietly = TRUE))
    install.packages("devtools")
devtools::install_git("https://github.com/koustav-pal/HiCBricks")

Getting Started

To start working with HiCBricks, please checkout the vignette (tutorial) here, at the main Bioconductor website. It contains an in-depth walkthrough of almost all functions in HiCBricks and will guide users through the process of

Development Notes

Future Roadmap

There are many new developments which are planned for future releases of HiCBricks. Broadly speaking,

Contributing

If you would like to help out, let me know via email at koustav.pal@ifom.eu.



koustav-pal/HiCLegos documentation built on Nov. 5, 2022, 5:49 p.m.