R Graphical Manual

Browse All

Last data update: 2014.03.03

R: Color legend

colorlegend

R Documentation

Color legend

Description

Creates a color legend for a vector used to color a plot. It will use the current palette() or the specified pal as reference.

Usage

colorlegend(col, pal = palette(), log = FALSE, posx = c(0.9, 0.93),
  posy = c(0.05, 0.9), main = NULL, main.cex = 1, main.col = par("fg"),
  lab.col = par("fg"), steps = 5, color.steps = 100, digit = 2,
  left = FALSE, ...)

Arguments

`col`	Vector of factor, integer, or double used to determine the ticks.
`pal`	If `col` is double, pal is used as a continuous palette, else as categorical one
`log`	Use logarithmic scale?
`posx`	Left and right borders of the color bar relative to plot area (Vector of length 2; 0-1)
`posy`	Bottom and top borders of color bar relative to plot area (Vector of length 2; 0-1)
`main`	Legend title
`main.cex`	Size of legend title font
`main.col`	Color of legend title
`lab.col`	Color of tick or category labels
`steps`	Number of labels in case of a continuous axis
`color.steps`	Number of gradient samples in case of continuous axis
`digit`	Number of digits for continuous axis labels
`left`	logical. If TRUE, invert posx
`...`	Additional parameters for the text call used for labels

Details

When passed a factor or integer vector, it will create a discrete legend, whereas a double vector will result in a continuous bar.

Value

This function is called for the side effect of adding a colorbar to a plot and returns nothing/NULL.

Examples

color.data <- 1:6
par(mar = par('mar') + c(0, 0, 0, 3))
plot(sample(6), col = color.data)
colorlegend(color.data)

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(destiny)
Loading required package: Biobase
Loading required package: BiocGenerics
Loading required package: parallel

Attaching package: 'BiocGenerics'

The following objects are masked from 'package:parallel':

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

The following objects are masked from 'package:stats':

    IQR, mad, xtabs

The following objects are masked from 'package:base':

    Filter, Find, Map, Position, Reduce, anyDuplicated, append,
    as.data.frame, cbind, colnames, do.call, duplicated, eval, evalq,
    get, grep, grepl, intersect, is.unsorted, lapply, lengths, mapply,
    match, mget, order, paste, pmax, pmax.int, pmin, pmin.int, rank,
    rbind, rownames, sapply, setdiff, sort, table, tapply, union,
    unique, unsplit

Welcome to Bioconductor

    Vignettes contain introductory material; view with
    'browseVignettes()'. To cite Bioconductor, see
    'citation("Biobase")', and for packages 'citation("pkgname")'.

> png(filename="/home/ddbj/snapshot/RGM3/R_BC/result/destiny/colorlegend.Rd_%03d_medium.png", width=480, height=480)
> ### Name: colorlegend
> ### Title: Color legend
> ### Aliases: colorlegend
> 
> ### ** Examples
> 
> color.data <- 1:6
> par(mar = par('mar') + c(0, 0, 0, 3))
> plot(sample(6), col = color.data)
> colorlegend(color.data)
> 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>