gpAddBaseNumbers: gpAddBaseNumbers

Description Usage Arguments Details Value See Also Examples

Description

Adds a ruler with base numbers to the plot

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
gpAddBaseNumbers(genoplot, label.exon.ends=TRUE, label.every.x=FALSE,
                           add.horizontal.line=FALSE, add.minor.ticks=TRUE,
                           custom.labels=NULL, ticks.in.introns=TRUE,
                           position="below.gene", inverted=FALSE,
                           add.units=TRUE, digits=2, shorten.labels=TRUE, cDNA=FALSE,
                           cex=0.6, label.col=NULL,
                           tick.dist=500, tick.len=0.2, tick.col=NULL,
                           minor.tick.dist=100, minor.tick.len=0.5, minor.tick.col=NULL,
                           r0=0, r1=1, data.panel=1,
                           col="black", pos=NULL, ...)

Arguments

genoplot

(GEnoPlot object) The GenoPlot object returned by the call to plotGene

label.exon.ends

(defaults to TRUE)

label.every.x

(defaults to FALSE)

add.horizontal.line

(defaults to FALSE)

add.minor.ticks

(defaults to TRUE)

custom.labels

(defaults to NULL)

ticks.in.introns

(defaults to TRUE)

position

(defaults to "below.gene")

inverted

(defaults to FALSE)

add.units

(defaults to TRUE)

digits

(defaults to 2)

shorten.labels

(defaults to TRUE)

cDNA

(defaults to FALSE)

cex

(defaults to 0.6)

label.col

(defaults to NULL)

tick.dist

(defaults to 500)

tick.len

(defaults to 0.2)

tick.col

(defaults to NULL)

minor.tick.dist

(defaults to 100)

minor.tick.len

(defaults to 0.5)

minor.tick.col

(defaults to NULL)

r0

(defaults to 0)

r1

(defaults to 1)

data.panel

(defaults to 1)

col

(defaults to "black")

pos

(defaults to NULL)

...

Details

This function adds a ruler to the plot marking the position of the plot elements in bases. It can either label the ends of the exons or create a label every a certain number of bases or both. The base numbers can be plotted any where in the genoplot as any other plot element but it's possible to plot them just below or just above the gene structure setting the parameter position to "below.gene" (default) or "above.gene". The representation is quite customizable and it's possible to decide if ticks will be plotted on intronic regions, if we want minor ticks between the labelled ticks, the colors, sizes and distances for major and minor ticks, whether labels should have units...

With the parameter col it's possible to determine the color of all elements, but there are parameters to specify the color of individual elements (labels, ticks...) and these take precendence over col.

Value

invisibly returns the given GenoPlot object

See Also

plotGene

Examples

1
2
gp <- plotGene(exons=toGRanges(c("chr1:1-200", "chr1:300-350")))
gpAddBaseNumbers(gp)

bernatgel/genoploteR documentation built on May 13, 2019, 5:22 p.m.