Package 'fourDNData'

Title: 4DN data package
Description: fourDNData is a data package giving programmatic access to Hi-C contact matrices uniformly processed by the [4DN consortium](https://www.4dnucleome.org/). The matrices are available in the multi-resolution `.mcool` format.
Authors: Jacques Serizay [aut, cre]
Maintainer: Jacques Serizay <[email protected]>
License: MIT + file LICENSE
Version: 1.12.0
Built: 2026-10-10 11:17:03 UTC
Source: https://github.com/bioc/fourDNData

Help Index


fourDNData

Description

Fetches files from the 4DN data portal and caches them using the BiocFileCache system.

Arguments

experimentSetAccession

Any 4DN-provided experimentSet Accession number (check https://data.4dnucleome.org/browse/) for a browser-based explorer.

type

any of c('pairs', 'hic', 'mcool', 'boundaries', 'insulation', 'compartments')

.fetch_pairs

Whether to also download the associated pairs file

Value

fourDNData() returns the local path of the queried file cached with BiocFileCache. fourDNHiCExperiment() returns a HiCExperiment object with populated metadata and topologicalFeatures ( if available).

Examples

####################################
## Importing individual 4DN files ##
####################################

head(fourDNData())
mcf <- fourDNData(experimentSetAccession = '4DNESDP9ECMN', type = 'mcool')
mcf

####################################
## Importing full 4DN experiments ##
####################################

id <- fourDNData() |>
  dplyr::filter(
     experimentType == 'in situ Hi-C', 
     biosource == 'GM12878', 
     publication == 'Sanborn AL et al. (2015)'
  ) |> 
  dplyr::arrange(size) |> 
  dplyr::pull(experimentSetAccession) |> 
  unique()
id[1]
x <- fourDNHiCExperiment(id[1])
x
HiCExperiment::topologicalFeatures(x)
S4Vectors::metadata(x)$`4DN_info`

Manage cache / download files from the 4DN data portal

Description

Managing 4DN data downloads via the integrated BiocFileCache system.

Usage

fourDNDataCache(...)

Arguments

...

Arguments passed to internal .setFourDNDataCache function

Value

BiocFileCache object

Examples

bfc <- fourDNDataCache()
bfc
BiocFileCache::bfcinfo(bfc)