getCytobandColors: getCytobandColors

View source: R/getCytobandColors.R

getCytobandColorsR Documentation

getCytobandColors

Description

Returns a named character vector with the colors of associated with the cytoband names

Usage

getCytobandColors(color.table=NULL, color.schema=c("circos", "biovizbase", "only.centromeres"))

Arguments

color.table

(named character vector) if present, it's returned as-is. Useful to specify your own color.tables.

color.schema

(character) The name of the color schema to use: circos, biovizBase, only.centromeres (everything in gray, except for centromeres in red). (defaults to circos)

Details

The function returns a named character vector with the colors of associated with the cytoband names. Two color schemas are available: circos (which copies the colors used by Circos) and biovizbase (that gets the cytoband colors from the biovizBase Bioconductor package). If a color.table is given, it is returned untouched.

Value

a named character vector with the colors associated to each cytoband name

See Also

plotKaryotype, kpAddCytobands

Examples

 
getCytobandColors()
getCytobandColors(color.schema="biovizbase")
 

bernatgel/karyoploteR documentation built on Feb. 1, 2024, 11:48 p.m.