RiverAxisLabel: River Axis Labels

In rivervis: River Visualisation Tool

Description

This adds left or right axis labels to the river chart.

Usage

RiverAxisLabel(label, riverlayout, cex = 0.7, adj = c(0.5, -2), srt = 90,
  col = "black", pos = NULL, offset = 0.5, side = "L",
  mainonly = TRUE)

Arguments

label	the axis label to be shown on the river chart.
riverlayout	the output list of RiverLayout.
cex	text size.
adj	text adjustment. One or two values in the range [0,1] for x and y (optional) adjustment.
srt	text angle.
col	text colour.
pos	text position. 1 for below, 2 for left, 3 for above, and 4 for right. See par for details.
offset	text position offset.
side	left ("L") or right ("R") axis.
mainonly	the axis title is only shown for the main stream only ("TRUE") or not ("FALSE").

Author(s)

Feng Mao

See Also

RiverLayout, RiverDraw, RiverMap. par.

Examples

# see examples below
data(Ballinderry)

riverlayout <- RiverLayout(B.river$River,B.river$Length,
                           B.river$Parent,B.river$Position,
                           B.river$Distance, direction = -1)
RiverDraw(riverlayout)

RiverBar(B.siteaspt$Site, B.siteaspt$River, B.siteaspt$Distance,
         B.siteaspt[4:5], riverlayout, range = c(0,8),
         bar.col = c("#5381FFFF", "#FF3931FF"), lbl.adj = c(0.5,1.3))

RiverTM(c(0,2,4,6,8,10), B.siteaspt[4:5], riverlayout,
        pos=-1, side = "L", range = c(0,8), label = c(0,2,4,6,8))

RiverAxisLabel("ASPT score", riverlayout, adj = c(0.5, -3))

rivervis documentation built on May 1, 2019, 7:28 p.m.