File: transrate.hmd.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 (52 lines) | stat: -rw-r--r-- 1,695 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
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Rcode.r
\name{transrate.hmd}
\alias{transrate.hmd}
\title{Reorganize Data obtained from Human Mortality Database into a Ratetable
Object}
\usage{
transrate.hmd(male, female)
}
\arguments{
\item{male}{a .txt file, containing the data on males.}

\item{female}{a .txt file, containing the data on females.}
}
\value{
An object of class \code{ratetable}.
}
\description{
The function assists in reorganizing the .txt files obtained from Human
Mortality Database (http://www.mortality.org) into a ratetable object.
}
\details{
This function works automatically with tables organised in the format
provided by the Human Mortality Database. Download Life Tables for Males and
Females separately from the column named 1x1 (period life tables, organized
by date of death, yearly cutpoints for age as well as calendar year).

If you wish to provide the data in the required format by yourself, note
that the only two columns needed are calendar year (Year) and probability of
death (qx). Death probabilities must be calculated up to age 110 (in yearly
intervals).
}
\examples{

\dontrun{
auspop <- transrate.hmd("mltper_1x1.txt","fltper_1x1.txt")
}

}
\references{
Package. Pohar M., Stare J. (2006) "Relative survival analysis
in R." Computer Methods and Programs in Biomedicine, \bold{81}: 272--278

Relative survival: Pohar, M., Stare, J. (2007) "Making relative survival
analysis relatively easy." Computers in biology and medicine, \bold{37}:
1741--1749.
}
\seealso{
\code{\link[survival:ratetable]{survival::ratetable}}, \code{\link{transrate.hld}},
\code{\link{joinrate}}, \code{\link{transrate}}.
}
\keyword{survival}