RiverReach: River Reach Plotting

Description Usage Arguments Author(s) See Also Examples

View source: R/RiverReach.R

Description

This highlights river reaches on the river chart.

Usage

1
2
3
4
5
RiverReach(reach, river, from, to, group, style, riverlayout, rea.pos = NA,
  rea.col = "lightblue", rea.lty = 1, rea.lwd = 1, rea.den = NULL,
  bd.col = "black", ln.shw = T, ln.col = "grey40", ln.lty = 3,
  ln.lwd = 1, pt.shw = T, pt.col = "black", pt.pch = 20,
  pt.bg = "black", pt.cex = 1, pt.lwd = 1)

Arguments

reach

a vector of reach names.

river

a vector of rivers to which the reaches belong.

from

a numeric vector of starting points.

to

a numeric vector of ending points.

group

a vector of reach group names. This indicates to which group the reaches belong.

style

a vector of reach styles. The value of "style" denotes the location of reach lines. Especially, 0 denotes "on axis" and 99 means "the reach is presented as a band rather than a line".

riverlayout

the output list of RiverLayout or RiverMap.

rea.pos

a vector of absolute positions of lines. The values range in [0,1].

rea.col

line colour.

rea.lty

line style.

rea.lwd

line width.

rea.den

the density of shading lines, in lines per inch. See rect.

bd.col

colour of river chart frames.

ln.shw

show lead lines (TRUE) or not (FALSE).

ln.col

lead line colour.

ln.lty

lead line style.

ln.lwd

lead line width.

pt.shw

show anchor point (TRUE) or not (FALSE). Anchor points represent the locations of the river mouths.

pt.col

anchor point colour.

pt.pch

anchor point style.

pt.bg

anchor point background(fill) colour when pch=21:25.

pt.cex

anchor point size.

pt.lwd

anchor point border width.

Author(s)

Feng Mao

See Also

RiverLayout, RiverDraw, RiverMap, par.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
data(Ballinderry)

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

RiverReach(B.reach$Reach, B.reach$River, B.reach$From,
           B.reach$To, B.reach$Group, B.reach$Style, riverlayout,
           rea.lwd = 5)

RiverReach(B.reach$Reach, B.reach$River, B.reach$From,
           B.reach$To, B.reach$Group, 2, riverlayout,
           rea.col = "darkred", rea.lwd = 5)

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