dense_zones: Finds transcription factor dense DNA zones for different...

View source: R/dense_zones.R

dense_zonesR Documentation

Finds transcription factor dense DNA zones for different accumulation threshold values.

Description

For each accumulation threshold value defined, this function finds transcription factor (TF) dense DNA zones (regions). Starting from the accumulation vector calculated with the accumulation function, each dense zone is formed by contiguous bases with accumulation equal or higher than the threshold. For each defined threshold value, the function finds also the number of dense zones, the number of total bases belonging to the dense zones, the minimum, maximum, mean, median and standard deviation of the dense zone lengths and of the distances between adjacent dense zones.

Usage

dense_zones(accumulation, threshold_step, chr = NULL, writeBed = FALSE)

Arguments

accumulation

a list of four elements containing: a Rle (or SimpleRleList) object with accumulation values (e.g., obtained with the accumulation function), the accumulation type, a chromosome name, and the half-width of the window used for the accumulation count.

threshold_step

an integer, the step used to calculate the threshold values. These values vary from 1 to the maximum accumulation value in the considered accumulation vector (e.g., found with the accumulation function). In the case of using accumulation values of base accumulation type and w different from zero (e.g., w=1000), choosing a step quite different from 1 is suggested because the maximum accumulation value is usually high.

chr

optional argument, a string with a cromosome name. It is needed to apply the function only to a single cromosome present in the accumulation input. If chr = "all" (default value) the function operates on all the chromosomes present in the input.

writeBed

When set to TRUE, for each threshold value (and for each chromosome) a ".bed" file with the chromosome and genomic coordinates of the dense zones found is created.

Value

A list of eight elements:

zones

a list with "GRanges" objects with the dense zones found for each chromosome and threshold value considered.

zones_count

a list with a data frame for each chromosome considered, containing the considered threshold values and the number of dense zones obtained with each of the threshold values.

bases_count

a list with a data frame for each chromosome considered, containing the considered threshold values and the total number of bases belonging to the dense zones obtained with each of the threshold values.

lengths

a list with a data frame for each chromosome considered, containing the considered threshold values and min, max, mean, median and standard deviation of the dense zone lengths obtained with each of the considered threshold values.

distances

a list with a data frame for each chromosome considered, containing the considered threshold values and min, max, mean, median and standard deviation of the distances between adjacent dense zones obtained with each of the threshold values.

acctype

a string with the accumulation type used.

chr

a string with the chromosome name associated with the output zones.

w

an integer with half-width of the window used to calculate the accumulation vector.

When writeBed is set to TRUE, for each threshold value (and for each chromosome) a ".bed" file with the chromosome and genomic coordinates of the dense zones found is created.

Examples

# loading data
data("data_man")
# TF_acc_w_0 is in the data_man collection of datasets
# to find dense zones, with threshold step equal to 1
TF_dense_w_0 <- dense_zones(TF_acc_w_0, 1)

DEIB-GECO/TFHAZ documentation built on July 29, 2023, 5:45 p.m.