File: plot.survmean.Rd

package info (click to toggle)
r-cran-popepi 0.4.13%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,656 kB
  • sloc: sh: 13; makefile: 2
file content (45 lines) | stat: -rw-r--r-- 1,360 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/S3_definitions.R
\name{plot.survmean}
\alias{plot.survmean}
\title{Graphically Inspect Curves Used in Mean Survival Computation}
\usage{
\method{plot}{survmean}(x, ...)
}
\arguments{
\item{x}{a \code{survmean} object}

\item{...}{arguments passed (ultimately) to \code{matlines}; you
may, therefore, supply e.g. \code{xlab} through this, though arguments
such as \code{lty} and \code{col} will not work}
}
\value{
Always returns \code{NULL} invisibly.
This function is called for its side effects.
}
\description{
Plots the observed (with extrapolation) and expected survival
curves for all strata in an object created by \verb{[survmean]}
}
\details{
For examples see \verb{[survmean]}. This function is intended only
for graphically inspecting that the observed survival curves with extrapolation
and the expected survival curves have been sensibly computed in \code{survmean}.

If you want finer control over the plotted curves, extract the curves from
the \code{survmean} output using

\code{attr(x, "curves")}

where \code{x} is a \code{survmean} object.
}
\seealso{
Other survmean functions: 
\code{\link{Surv}()},
\code{\link{lines.survmean}()},
\code{\link{survmean}()}
}
\author{
Joonas Miettinen
}
\concept{survmean functions}