get3UTRAPApd: Get proximal and distal 3'UTR APAs

View source: R/R_funclib_movAPA.r

get3UTRAPApdR Documentation

Get proximal and distal 3'UTR APAs

Description

get3UTRAPApd provides a smarter way to get proximal and distal 3'UTR APAs then get3UTRAPAds. Criteria for a proximal and distal pair in a gene: first select APA pairs from all APA pairs that meet the dist and ratio criteria; then the final P/D pair is the one with the highest count sum and the closest distance. Note that there is no filtering of PA expression levels here, which can be performed before get3UTRAPApd using subsetPACds().

Usage

get3UTRAPApd(
  pacds,
  minDist = 50,
  maxDist = 10000,
  minRatio = 0.05,
  fixDistal = FALSE,
  addCols = "pd"
)

Arguments

pacds

a PACdataset, if it contains non-3UTR PAs, will run get3UTRAPAds first to subset 3UTR PAs.

minDist

the distance of the proximal and distal PA should be in [minDist, maxDist].

maxDist

the distance of the proximal and distal PA should be in [minDist, maxDist]. It is recommended to use getNearbyPAdist to estimate an appropriate distance.

minRatio

If minRatio>0, then will remove PAs with ratio<minRatio before getting P/D PAs.

fixDistal

TRUE means that the most distal PA is fixed and then only searches for the proximal PA for that distal PA.

addCols

If not NULL, then four columns would be added to PACds@anno, inlucidng <addCols>Which/Score/Ratio/Dist. Among these columns, the 'which' column denotes P or D of each PA.

Value

A PACdataset with only 3'UTR P-D APA sites. If there is no result, return an empty PACdataset with 0-row @anno and @counts.

See Also

subsetPACds get3UTRAPAds movAPAindex

Other PACdataset functions: PACdataset-class, PACds, annotateByPAS(), annotatePAC(), createPACdataset(), get3UTRAPAds(), length(), makeExamplePACds(), mergePACds(), normalizePACds(), plotPACdsStat(), rbind(), readPACds(), removePACdsIP(), scPACds, subscript_operator, summary(), writePACds()

Examples

data(PACds)
## to get a glance of the distance between nearby 3UTR pAs
getNearbyPAdist(PACds, ftrs='3UTR', within='ftr', return='null')
pd1=get3UTRAPApd(PACds, minDist=50, maxDist=1000, minRatio=0.05, fixDistal=F)
pd2=get3UTRAPApd(PACds, minDist=50, maxDist=1000, minRatio=0.05, fixDistal=T)
g=PACds@anno$gene[!(pacds@anno$gene %in% pd1@anno$gene)]
subsetPACds(pd1, gene=g)
subsetPACds(pd2, gene=g)

BMILAB/movAPA documentation built on Jan. 3, 2024, 11:09 p.m.