prFpDrawLine: Draws a straight line
In forestplot: Advanced Forest Plot Using 'grid' Graphics

prFpDrawLine

R Documentation

Draws a straight line

Description

If the line is outside the boundaries the line is clipped with an arrow at the limit indicating that it continues. If the lower limit is not below the upper limit the line is not drawn.

Usage

prFpDrawLine(
  lower_limit,
  upper_limit,
  clr.line,
  lwd,
  lty,
  y.offset,
  vertices,
  vertices.height = 0.1,
  line_gp,
  vertices_gp
)

Arguments

`lower_limit`	The lower limit of the confidence line. A native numeric variable that can actually be outside the boundaries. If you want to see if it is outside then convert it to 'npc' and see if the value ends up more than 1 or less than 0. Here's how you do the conversion: `convertX(unit(upper_limit, "native"), "npc", valueOnly = TRUE)` and the `convertX` together with `unit` is needed to get the right values while you need to provide the valueOnly as you cannot compare a unit object.
`upper_limit`	The upper limit of the confidence line. See lower_limit for details.
`clr.line`	Legacy color of line (please, use line_gp)
`lwd`	Legacy width of line (please, use line_gp)
`lty`	Legacy type of line (please, use line_gp)
`y.offset`	If you have multiple lines they need an offset in the y-direction.
`vertices`	Set this to TRUE if you want the ends of the confidence intervals to be shaped as a T. This is set default to TRUE if you have any other line type than 1 since there is a risk of a dash occurring at the very end, i.e. showing incorrectly narrow confidence interval.
`vertices.height`	The height hoft the vertices. Defaults to npc units corresponding to 10% of the row height.
`line_gp`	A `gpar` for drawing the horizontal line
`vertices_gp`	A `gpar` for drawing the vertices. unspecified attributes in vertices_gp default to line_gp.