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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
# sire - simulated survival data ------------------------------------------
#' sire - a simulated cohort of Finnish female rectal cancer patients
#'
#' `sire` is a simulated cohort pertaining female Finnish rectal cancer patients
#' diagnosed between 1993-2012. Instead of actual original dates, the dates are masked
#' via modest randomization within several time windows.
#'
#' The closing date for the pertinent data was 2012-12-31, meaning status information was
#' available only up to that point --- hence the maximum possible `ex_date` is `2012-12-31`.
#'
#' @source The Finnish Cancer Registry
#' @format data.table with columns
#' \itemize{
#' \item sex - gender of the patient (1 = female)
#' \item bi_date - date of birth
#' \item dg_date - date of cancer diagnosis
#' \item ex_date - date of exit from follow-up (death or censoring)
#' \item status - status of the person at exit; 0 alive; 1 dead due to pertinent cancer; 2 dead due to other causes
#' \item dg_age - age at diagnosis expressed as fractional years
#' }
#' @author Karri Seppa
#' @name sire
#' @family popEpi data
#' @family survival data
NULL
# sibr - simulated survival data ------------------------------------------
#' sibr - a simulated cohort of Finnish female breast cancer patients
#'
#' `sibr` is a simulated cohort pertaining female Finnish breast cancer patients
#' diagnosed between 1993-2012. Instead of actual original dates, the dates are masked
#' via modest randomization within several time windows. The dataset is additionally
#' a random sample of 10 000 cases from the pertaining time window.
#'
#' The closing date for the pertinent data was 2012-12-31, meaning status information was
#' available only up to that point --- hence the maximum possible `ex_date` is `2012-12-31`.
#'
#' @source The Finnish Cancer Registry
#' @format data.table with columns
#' \itemize{
#' \item sex - gender of the patient (1 = female)
#' \item bi_date - date of birth
#' \item dg_date - date of cancer diagnosis
#' \item ex_date - date of exit from follow-up (death or censoring)
#' \item status - status of the person at exit; 0 alive; 1 dead due to pertinent cancer; 2 dead due to other causes
#' \item dg_age - age at diagnosis expressed as fractional years
#' }
#' @author Karri Seppa
#' @name sibr
#' @family popEpi data
#' @family survival data
NULL
# International standard weights ------------------------------------------
#' Age standardisation weights from the ICSS scheme.
#'
#' Contains three sets age-standardisation weights for age-standardized survival (net, relative or observed).
#'
#'
#' @source
#' \href{https://seer.cancer.gov/stdpopulations/survival.html}{ICSS weights (US National Cancer Institute website)}
#'
#' Corazziari, Isabella, Mike Quinn, and Riccardo Capocaccia. "Standard cancer patient population for age standardising survival ratios." European Journal of Cancer 40.15 (2004): 2307-2316.
#' @format data.table with columns
#' \itemize{
#' \item age - lower bound of the age group
#' \item ICSS1 - first set of weights, sums to 100 000
#' \item ICSS2 - second set of weights, sums to 100 000
#' \item ICSS3 - third set of weights, sums to 100 000
#' }
#' @name ICSS
#' @family popEpi data
#' @family weights
#' @examples
#' ## aggregate weights to a subset of age groups
#' data(ICSS)
#' cut <- c(0, 30, 50, 70, Inf)
#' agegr <- cut(ICSS$age, cut, right = FALSE)
#' aggregate(ICSS1~agegr, data = ICSS, FUN = sum)
NULL
# popmort -------------------------------------------------------------------
#' Population mortality rates in Finland 1951 - 2013 in 101 age groups and
#' by gender. This is an example of a population hazard table as used in
#' \pkg{popEpi}; for the general help page, see `[pophaz]`.
#'
#'
#' @source Statistics Finland
#' @format `data.table` with columns
#' \itemize{
#' \item `sex` gender coded as male, female (0, 1)
#' \item `year` calendar year
#' \item `agegroup` - coded 0 to 100; one-year age groups
#' \item `haz` the average population mortality rate per person-year
#' (d/(pyrs), where d is the number of deaths and pyrs is the person-years)
#' }
#' @name popmort
#' @family popEpi data
#' @seealso `[pophaz]`
NULL
# stdpop18 ------------------------------------------------------------------
#' Standard populations from 2000: world, Europe and Nordic.
#'
#' World, European, and Nordic standard populations by 18 age categories.
#' Sums to 100000.
#'
#' @source Nordcan, 2000
#' @format data.table with columns
#' \itemize{
#' \item `agegroup`, age group in 18 categories (character)
#' \item `world`, World 2000 standard population (numeric)
#' \item `europe`, European standard population (numeric)
#' \item `nordic`, Nordic standard population (numeric)
#' }
#' @name stdpop18
#' @family popEpi data
#' @family weights
NULL
# stdpop101 -----------------------------------------------------------------
#' World standard population by 1 year age groups from 1 to 101. Sums to 100 000.
#'
#'
#' @source Standard population is from:
#' \href{https://seer.cancer.gov/stdpopulations/stdpop.singleages.html}{world standard population "101of1"}
#'
#' @format data.table with columns
#' \itemize{
#' \item `world_std` weight that sums to 100000 (numeric)
#' \item `agegroup` age group from 1 to 101 (numeric)
#' }
#' @name stdpop101
#' @family popEpi data
#' @family weights
NULL
# meanpop_fi -------------------------------------------------------------------
#' Mean population counts in Finland year, sex, and age group.
#'
#' @source Statistics Finland
#' @format `data.table` with columns
#' \itemize{
#' \item `sex` gender coded as male, female (0, 1)
#' \item `year` calendar year 1981-2016
#' \item `agegroup` - coded 0 to 100; one-year age groups
#' \item `meanpop` the mean population count; that is, the mean of the
#' annual population counts of two consecutive years; e.g. for 1990
#' `meanpop` is the mean of population counts for 1990 and 1991
#' (counted at 1990-01-01 and 1991-01-01, respectively)
#' }
#' @name meanpop_fi
#' @family popEpi data
NULL
|
