Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

https://forge.inrae.fr/scales/treediff.git
23 July 2025, 17:13:49 UTC
  • Code
  • Branches (4)
  • Releases (0)
  • Visits
    • Branches
    • Releases
    • HEAD
    • refs/heads/main
    • refs/tags/0.2.1
    • refs/tags/v0.1
    • refs/tags/v0.2
    No releases to show
  • fae4c61
  • /
  • man
  • /
  • HiC2Tree.Rd
Raw File Download Save again
Take a new snapshot of a software origin

If the archived software origin currently browsed is not synchronized with its upstream version (for instance when new commits have been issued), you can explicitly request Software Heritage to take a new snapshot of it.

Use the form below to proceed. Once a request has been submitted and accepted, it will be processed as soon as possible. You can then check its processing state by visiting this dedicated page.
swh spinner

Processing "take a new snapshot" request ...

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
  • revision
  • snapshot
origin badgecontent badge
swh:1:cnt:a5936a4d7e6e9a739ece96cf323ac6c496b87101
origin badgedirectory badge
swh:1:dir:f865ad7b7c09a2303f42401aec28fa79c3174c82
origin badgerevision badge
swh:1:rev:30cc31c246b05c8a5519367969efe4d81f93ac19
origin badgesnapshot badge
swh:1:snp:c36295817c399bf58e154ba758a9746fb381d408

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
  • revision
  • snapshot
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
Tip revision: 30cc31c246b05c8a5519367969efe4d81f93ac19 authored by Nathalie Vialaneix on 28 May 2023, 09:38:44 UTC
reduced computational time of HiC examples
Tip revision: 30cc31c
HiC2Tree.Rd
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/HiC2Tree.R
\name{HiC2Tree}
\alias{HiC2Tree}
\title{Hi-C to trees}
\usage{
HiC2Tree(files, format, binsize = NULL, index = NULL, chromosomes, replicates)
}
\arguments{
\item{files}{A character vector containing the file paths of the input data.}

\item{format}{A character vector indicating the format of the input data:
"tabular", "cooler", "juicer", or "HiC-Pro".}

\item{binsize}{An integer indicating the bin size of the Hi-C matrix.}

\item{index}{A character indicating the path of the index for the input data.
Required (and used) only with the "HiC-Pro" format.}

\item{chromosomes}{A vector containing the chromosomes to be included in the
analysis.}

\item{replicates}{An integer indicating the number of replicates to be used
in treediff.}
}
\value{
A list containing: 
\itemize{
  \item{trees}{ A list of all trees.}
  \item{metadata}{ A data frame containing the following columns: names (name
  of each tree), chromosome, cluster, and file.}
  \item{index}{ A data table containing the correspondence of each bin in the
  genome.}
  \item{testRes}{ A list of treediff results for each cluster.}
}
}
\description{
This function converts Hi-C data into trees, using the adjclust
algorithm. It takes as input a file path vector, the format of the input
data, the bin size of the Hi-C array, the chromosomes to be included in the
analysis, and the number of replicates. It returns a list containing all
trees, metadata, index and treediff results.
}
\examples{
replicates <- 1:3
cond <- c("90", "110")
all_begins <- interaction(expand.grid(replicates, cond), sep = "-")
all_begins <- as.character(all_begins)

# single chromosome
nb_chr <- 1
chromosomes <- 1:nb_chr
all_mat_chr <- lapply(chromosomes, function(chr) {
  all_mat <- lapply(all_begins, function(ab) {
    mat_file <- paste0("Rep", ab, "-chr", chr, "_200000.bed")
  })
  all_mat <- unlist(all_mat)
})
index <- system.file("extdata", "index.200000.longest18chr.abs.bed",
                     package = "treediff")
format <- rep("HiC-Pro", length(replicates) * length(cond) * nb_chr)
binsize <- 200000
files <- system.file("extdata", unlist(all_mat_chr), package = "treediff")
replicates <- c(3, 3)
HiC2Tree(files, format, binsize, index, chromosomes, replicates)

\dontrun{
# two chromosomes
nb_chr <- 2
chromosomes <- 1:nb_chr
all_mat_chr <- lapply(chromosomes, function(chr) {
  all_mat <- lapply(all_begins, function(ab) {
    mat_file <- paste0("Rep", ab, "-chr", chr, "_200000.bed")
  })
  all_mat <- unlist(all_mat)
})
files <- system.file("extdata", unlist(all_mat_chr), package = "treediff")
format <- rep("HiC-Pro", length(replicates) * length(cond) * nb_chr)
replicates <- c(3, 3)
HiC2Tree(files, format, binsize, index, chromosomes, replicates)
}

}

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API