/
sl3-package.R
177 lines (171 loc) 路 4.34 KB
/
sl3-package.R
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
176
177
#' @import R6
#' @import data.table
#' @import delayed
#' @importFrom methods is
#
NULL
#' Undocumented Learner
#'
#' We haven't documented this one yet. Feel free to contribute!
#'
#' @docType class
#'
#' @importFrom R6 R6Class
#'
#' @keywords data
#'
#' @return \code{\link{Lrnr_base}} object with methods for training and
#' prediction.
#'
#' @format \code{\link{R6Class}} object.
#'
#' @field params A list of parameters needed to fully specify the learner. This
#' includes things like model hyperparameters.
#'
#' @family Learners
#'
#' @name undocumented_learner
#
NULL
#' Subset of growth data from the collaborative perinatal project (CPP)
#'
#' @description
#' Subset of growth data from the collaborative perinatal project (CPP).
#' \code{cpp_imputed} drops observations for which the \code{haz} column is
#' \code{NA}, and imputes all other observations as 0. This is only for the
#' purposes of simplifying testing and examples.
#'
#' @format A data frame with 1,912 repated-measures observations and 500 unique
#' subjects:
#'
#' \describe{
#' \item{subjid}{Subject ID}
#' \item{agedays}{Age since birth at examination (days)}
#' \item{wtkg}{Weight (kg)}
#' \item{htcm}{Standing height (cm)}
#' \item{lencm}{Recumbent length (cm)}
#' \item{bmi}{BMI (kg/m**2)}
#' \item{waz}{Weight for age z-score}
#' \item{haz}{Length/height for age z-score}
#' \item{whz}{Weight for length/height z-score}
#' \item{baz}{BMI for age z-score}
#' \item{siteid}{Investigational Site ID}
#' \item{sexn}{Sex (num)}
#' \item{sex}{Sex}
#' \item{feedingn}{Maternal breastfeeding status (num)}
#' \item{feeding}{Maternal breastfeeding status}
#' \item{gagebrth}{Gestational age at birth (days)}
#' \item{birthwt}{Birth weight (gm)}
#' \item{birthlen}{Birth length (cm)}
#' \item{apgar1}{APGAR Score 1 min after birth}
#' \item{apgar5}{APGAR Score 5 min after birth}
#' \item{mage}{Maternal age at birth of child (yrs)}
#' \item{mracen}{Maternal race (num)}
#' \item{mrace}{Maternal race}
#' \item{mmaritn}{Mothers marital status (num)}
#' \item{mmarit}{Mothers marital status}
#' \item{meducyrs}{Mother, years of education}
#' \item{sesn}{Socio-economic status (num)}
#' \item{ses}{Socio-economic status}
#' \item{parity}{Maternal parity}
#' \item{gravida}{Maternal num pregnancies}
#' \item{smoked}{Maternal smoking status}
#' \item{mcignum}{Num cigarettes mom smoked per day}
#' \item{comprisk}{Maternal risk factors}
#' }
#'
#' @name cpp
#'
#' @docType data
#'
#' @source
#' \url{https://catalog.archives.gov/id/606622}
#'
#' Broman, Sarah. 'The collaborative perinatal project: an overview.' Handbook
#' of longitudinal research 1 (1984): 185-227.
#'
#' @usage data(cpp)
#' @usage data(cpp_imputed)
#'
#' @keywords data
#'
#' @examples
#' data(cpp)
#' head(cpp)
#' #
NULL
#' @name cpp_imputed
#' @rdname cpp
#
NULL
#' Subset of growth data from the collaborative perinatal project (CPP)
#'
#' @name cpp_1yr
#'
#' @docType data
#'
#' @description
#' Subset of growth data from the collaborative perinatal project (CPP) at
#' single time-point. The rows in original \code{cpp} data were subset for
#' agedays==366. See \code{?cpp} for the description of the variables.
#'
#' @source
#' \url{https://catalog.archives.gov/id/606622}
#'
#' Broman, Sarah. 'The collaborative perinatal project: an overview.' Handbook
#' of longitudinal research 1 (1984): 185-227.
#'
#' @usage data(cpp_1yr)
#'
#' @keywords data
#'
#' @examples
#' data(cpp_1yr)
#' head(cpp_1yr)
#' table(cpp_1yr[["agedays"]])
#' #
NULL
#' Bicycle sharing time series dataset
#'
#' @name bsds
#'
#' @docType data
#'
#' @description
#' Bicycle sharing time series dataset from the UCI Machine Learning Repository.
#'
#' @source
#' \url{https://archive.ics.uci.edu/ml/datasets/bike+sharing+dataset}
#'
#' Fanaee-T, Hadi, and Gama, Joao, 'Event labeling combining ensemble detectors
#' and background knowledge', Progress in Artificial Intelligence (2013): pp.
#' 1-15, Springer Berlin Heidelberg
#'
#' @usage data(bsds)
#'
#' @keywords data
#'
#' @examples
#' data(bsds)
#' head(bsds)
#' #
NULL
#' Simulated data with continuous exposure
#'
#' @name density_dat
#'
#' @docType data
#'
#' @description
#' Simulated data with continuous exposure, used with examples of conditional
#' density estimation.
#'
#' @usage data(density_dat)
#'
#' @keywords data
#'
#' @examples
#' data(density_dat)
#' head(density_dat)
#' #
NULL