extendTSS: Extend TSS

In jokergoo/rGREAT: GREAT Analysis - Functional Enrichment on Genomic Regions

Extend TSS

Description

Extend TSS

Usage

extendTSS(gene, seqlengths = NULL, genome = NULL,
    gene_id_type = NULL, mode = "basalPlusExt", extend_from = c("TSS", "gene"),
    basal_upstream = 5000, basal_downstream = 1000, extension = 1000000,
    verbose = great_opt$verbose, .attr = list())

Arguments

gene	A GRanges object of gene (or TSS) coordinates.
extend_from	Should the gene be extended only from its TSS or the complete gene?
seqlengths	A named vector of chromosome lengths. If it is not provided, it is taken by seqlengths(gene).
genome	UCSC genome can be set here, then seqlengths will be automatically retrieved from UCSC server.
gene_id_type	Gene ID types in gene. You need to set this argument if you use built-in gene sets in great so that genes can be correctly mapped. The value can only be one of "SYMBOL", "ENTREZ", "ENSEMBL" and "REFSEQ".
mode	The mode to extend TSS. Value should be one of 'basalPlusExt', 'twoClosest' and 'oneClosest'. See "Details" section.
basal_upstream	In 'basalPlusExt' mode, number of base pairs extending to the upstream of TSS to form the basal domains.
basal_downstream	In 'basalPlusExt' mode, number of base pairs extending to the downstream of TSS to form the basal domains.
extension	Extensions from the basal domains. The value can also be a vector of length two which corresponds to extension to upstream and downstream respectively.
verbose	Whether to print messages.
.attr	Only used internally.

Details

Following are general explanations of the three modes for extending TSS:

basalPlusExt

1. TSS are extended into basal domains (e.g. by upstream 5kb, downstream 1kb); 2. basal domains are sorted by their genomic coordinates; 3. each basal domain is extended to its both sides until it reaches the next TSS's basal domain or it reaches the maximal extension (e.g. 1000kb).

twoClosest

1. TSS are sorted by their genomic coordinates; 2. each TSS is extended to its both sides until it reaches the next TSS or it reaches the maximal extension (e.g. 1000kb).

oneClosest

1. TSS are sorted by their genomic coordinates; 2. each TSS is extended to its both sides until it reaches the middle point of itself and the next TSS or it reaches the maximal extension (e.g. 1000kb).

The official explanation is at https://great-help.atlassian.net/wiki/spaces/GREAT/pages/655443/Association+Rules .

Value

A GRanges object with one meta column 'gene_id'.

Examples

# There is no example
NULL

jokergoo/rGREAT documentation built on March 28, 2024, 5:31 a.m.