colorBar: Draws a color bar in a figure

View source: R/statmap.R View source: R/pbj.R

colorBarR Documentation

Draws a color bar in a figure

Description

Can be used in combination with layout and image.statMap to create figures.

Usage

colorBar(
  lut,
  min,
  max = -min,
  nticks = 11,
  ticks = seq(min, max, len = nticks),
  title = ""
)

Arguments

lut

the range of colors to display

min

Where to put the minimum tick mark.

max

Where to put the maximum tick mark.

nticks

Number of ticks on the color bar.

ticks

Locations for ticks.

title

The title for the color bar

ylab

label for the color bar.

las

argument passed to par.

Details

Returns a statistical niftiImage object from a statMap object

Value

a niftiImage object of the coefficient image


simonvandekar/pbj documentation built on Nov. 3, 2023, 9:33 a.m.