plotRecruitment-RCurve-method: Method for plotting the Recruitment Function of a RCurve...

Description Usage Arguments Examples

Description

This plots an RCurve Recruitment Function

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## S4 method for signature 'RCurve'
plotRecruitment(
  theObject,
  overlay = FALSE,
  maxT = 100,
  increment = 0.1,
  xlab = "Time",
  ylab = "Patients",
  main = "Recruitment plot",
  type = "l",
  ...
)

Arguments

theObject

The name of the RCurve Object

overlay

Boolean whether to overlay on existing one (vs start a new one). Default=FALSE

maxT

Maximum time to plot up to. Default=100

increment

Plotting time increment. Default=0.1

xlab

X-axis label. Default="Time"

ylab

Y-axis label. Default="Patients"

main

title of plot. Default="Recruitment plot"

type

type of plot (see standard graphical parameters). Default="l" (lines).

...

Standard graphical parameter arguments to be passed on to 'plot'/'lines', e.g. to change appearance of plot.

Examples

1
2
3
plotRecruitment(LinearR(12,100,100))
plotRecruitment(LinearR(12,100,100),xlab="Test x label",maxT=60)
plotRecruitment(LinearR(20,90,90),overlay=TRUE,col=2,lty=2)

gestate documentation built on Feb. 20, 2020, 5:08 p.m.