bundle: Combine discovery objects

In robinweide/GENOVA: GENOVA: expore the Hi-C

Combine discovery objects

Description

bundle takes one or more GENOVA discovery objects and combines them along experiments.

Usage

bundle(..., collapse = "_")

## S3 method for class 'ARMLA_discovery'
bundle(..., collapse = "_")

## S3 method for class 'domainogram_discovery'
bundle(..., collapse = "_")

## S3 method for class 'IS_discovery'
bundle(..., collapse = "_")

## S3 method for class 'virtual4C_discovery'
bundle(..., collapse = "_")

## S3 method for class 'CS_discovery'
bundle(..., collapse = "_")

## S3 method for class 'saddle_discovery'
bundle(..., collapse = "_")

## S3 method for class 'RCP_discovery'
bundle(..., collapse = "_")

## S3 method for class 'DI_discovery'
bundle(..., collapse = "_")

## S3 method for class 'IIT_discovery'
bundle(..., collapse = "_")

## S3 method for class 'chrommat_discovery'
bundle(..., collapse = "_")

Arguments

...	A number of discovery objects from the same analysis type.
collapse	An optional character string to seperate names in case the experiment names are not unique. Not NA_character_.

Details

This function can be convenient when a the same analysis has been run on a sequence of experiments with parameters specific to the experiment. For example, consider the case when ATAs have been run on several single experiments with TAD boundary anchors that match that same experiment. The bundle function allows combining the resulting discovery objects for visualisation or quantification.

The arrays in slots of the discovery objects need to have compatible first and second dimensions, i.e. they must have had the same 'size_bp' or 'size_bin' arguments and have been run at the same resolutions.

Value

A discovery-class object of the same type.

See Also

The discovery class. unbundle for splitting discovery objects.

Examples

## Not run: 
# Running multiple analysis
ata1 <- ATA(WT_10kb, tads_wt)
ata2 <- ATA(KO_10kb, tads_ko)

# Combining results
cata <- bundle(WT = ata1, KO = ata2)

# Visualising the combined results
visualise(cata)

## End(Not run)

robinweide/GENOVA documentation built on March 14, 2024, 11:16 p.m.