File: summary.cmp.rel.Rd

package info (click to toggle)
r-cran-relsurv 2.3-2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: ansic: 1,223; cpp: 138; makefile: 2
file content (47 lines) | stat: -rw-r--r-- 1,364 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
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cmprel.r
\name{summary.cmp.rel}
\alias{summary.cmp.rel}
\title{Summary of the crude probability of death}
\usage{
\method{summary}{cmp.rel}(object, times, scale = 365.241, area = FALSE, ...)
}
\arguments{
\item{object}{output of the function \code{cmp.rel}.}

\item{times}{the times at which the output is required.}

\item{scale}{The time scale in which the times are specified. The default
value is \code{1}, i.e. days.}

\item{area}{Should area under the curves at time \code{tau} be printed out?
Default is \code{FALSE}.}

\item{...}{Additional arguments, currently not implemented}
}
\value{
A list of values is returned.
}
\description{
Returns a list containing the estimated values at required times.
}
\details{
The variance is calculated using numerical integration. If the required time
is not a time at which the value was estimated, the value at the last time
before it is reported. The density of the time points is set by the
\code{precision} argument in the \code{cmp.rel} function.
}
\examples{

data(slopop)
data(rdata)
#calculate the crude probability of death and summarize it
fit <- cmp.rel(Surv(time,cens)~sex,rmap=list(age=age*365),
      ratetable=slopop,data=rdata,tau=3652.41)
summary(fit,c(1,3),scale=365.241)

}
\seealso{
\code{cmp.rel}
}
\keyword{survival}