fishPlot: Given a fish object containing layout information, draw the...

View source: R/draw.R

fishPlotR Documentation

Given a fish object containing layout information, draw the fish plot

Description

Given a fish object containing layout information, draw the fish plot

Usage

fishPlot(
  fish,
  shape = "polygon",
  vlines = NULL,
  col.vline = "#FFFFFF99",
  vlab = NULL,
  border = 0.5,
  col.border = "#777777",
  pad.left = 0.2,
  ramp.angle = 0.5,
  title = NULL,
  title.btm = NULL,
  cex.title = NULL,
  cex.vlab = 0.7,
  bg.type = "gradient",
  bg.col = c("bisque", "darkgoldenrod1", "darkorange3")
)

Arguments

fish

A fish object that contains layout information

shape

The type of shape to construct the plot out of. The "spline" and "polygon" methods work well. "bezier" is more hit or miss

vlines

A vector of x positions at which to draw vertical lines

col.vline

A color value for the vertical lines

vlab

A character vector containing labels for each of the vertical lines

border

A numeric width for the border line around this polygon

col.border

A color for the border line

pad.left

The amount of "ramp-up" to the left of the first timepoint. Given as a fraction of the total plot width. Default 0.2

ramp.angle

A numeric value between 0 and 1 that indicates how steeply the shape should expand from it's leftmost origin to the first measured point. Only used when shape="polygon".

title

A string for the title above the plot

title.btm

A string for the title at the bottom left, internal to the plot

cex.title

A numeric value for scaling the title size

cex.vlab

A numeric value for scaling the top label size default is 0.7

bg.type

A string giving the background type - either "gradient" (default) or "solid". Default is "gradient".

bg.col

A string or vector of strings giving the background color. For type "solid", one color expected. For type "gradient", a vector of three colors is expected.

Value

No return value, outputs on graphics device

Examples

## Not run: 
fishPlot(fish,shape="polygon",title.btm="633734",
           vlines=c(0,150), vlab=c("day 0","day 150"), cex.title=0.5)

## End(Not run)

chrisamiller/fishplot documentation built on Sept. 15, 2023, 1:53 p.m.