Learn R Programming

hiAnnotator (version 1.6.2)

Functions for annotating GRanges objects

Description

hiAnnotator contains set of functions which allow users to annotate a GRanges object with custom set of annotations. The basic philosophy of this package is to take two GRanges objects (query & subject) with common set of seqnames (i.e. chromosomes) and return associated annotation per seqnames and rows from the query matching seqnames and rows from the subject (i.e. genes or cpg islands). The package comes with three types of annotation functions which calculates if a position from query is: within a feature, near a feature, or count features in defined window sizes. Moreover, each function is equipped with parallel backend to utilize the foreach package. In addition, the package is equipped with wrapper functions, which finds appropriate columns needed to make a GRanges object from a common data frame.

Copy Link

Version

Version

1.6.2

License

GPL (>= 2)

Maintainer

Last Published

February 15th, 2017

Functions in hiAnnotator (1.6.2)

getSitesInFeature

Find overlapping positions/ranges that match between the query and subject.
get2NearestFeature

Get two nearest upstream and downstream annotation boundary for a position range.
getFeatureCountsBig

Get counts of annotation within a defined window around each query range/position for large annotation objects spanning greater than 1 billion rows.
getFeatureCounts

Get counts of annotation within a defined window around each query range or positions.
getWindowLabel

Generate a window size label.
cleanColname

Clean the supplied string from punctuations and spaces.
getRelevantCol

Find the column index of interest given the potential choices.
getNearestFeature

Get nearest annotation boundary for a position range.
plotdisFeature

Plot distance distribution to a feature boundary.
makeChunks

Breaks two GRanges objects into chunks of N size.
sites.ctrl

Controls for Sample Retrovirus Integration Sites data
getLowestDists

Get the lowest biological distance from the 5' or 3' boundaries of query and subject.
hiAnnotator

Annotating GRanges objects with hiAnnotator.
makeGRanges

Make a sorted GRanges object from a dataframe.
sites

Sample Retrovirus Integration Sites data
doAnnotation

Annotate a GRanges object using one of annotation functions.
genes

Sample RefSeq genes annotation
getUCSCtable

Obtain a UCSC annotation table given the table & track name.
makeUCSCsession

Initiate UCSC genome browser session given the freeze argument.