kpAddChromosomeNames {karyoploteR} | R Documentation

## kpAddChromosomeNames

### Description

Plots the chromosome names in the karyoplot

### Usage

    kpAddChromosomeNames(karyoplot, chr.names=NULL, xoffset=0, yoffset=0, ...)

### Arguments

`karyoplot` | a `karyoplot` object returned by a call to `plotKaryotype`
`chr.names` | (character vector) the names to use for the chromosomes. If NULL, the chromosome names in the original genome will be used. (defaults to NULL)
`xoffset` | (numeric) a number of units to move the the chromosome names on the x axis with respect to their standard position (defaults to 0)
`yoffset` | (numeric) a number of units to move the the chromosome names on the y axis with respect to their standard position (defaults to 0)
`...` | any additional parameter to be passed to the text plotting. All R base graphics params are passed along.

### Details

Given a KaryoPlot object, plot the names of the depicted chromosomes. This function is usually automatically called by plotKaryotype unless `labels.plotter` is NULL.

### Value

invisibly returns the given karyoplot object

### See Also

`plotKaryotype`, `getChromosomeNamesBoundingBox`

### Examples

    kp <- plotKaryotype(labels.plotter = NULL)
    kpAddChromosomeNames(kp, col="red", srt=30)

[Package karyoploteR version 1.20.3 Index]