/
labelled_spss.R
289 lines (247 loc) · 8.58 KB
/
labelled_spss.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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
#' Labelled vectors for SPSS
#'
#' This class is only used when `user_na = TRUE` in
#' [read_sav()]. It is similar to the [labelled()] class
#' but it also models SPSS's user-defined missings, which can be up to
#' three distinct values, or for numeric vectors a range.
#'
#' @param na_values A vector of values that should also be considered as missing.
#' @param na_range A numeric vector of length two giving the (inclusive) extents
#' of the range. Use `-Inf` and `Inf` if you want the range to be
#' open ended.
#' @inheritParams labelled
#' @export
#' @examples
#' x1 <- labelled_spss(1:10, c(Good = 1, Bad = 8), na_values = c(9, 10))
#' is.na(x1)
#'
#' x2 <- labelled_spss(
#' 1:10,
#' c(Good = 1, Bad = 8),
#' na_range = c(9, Inf),
#' label = "Quality rating"
#' )
#' is.na(x2)
#'
#' # Print data and metadata
#' x2
labelled_spss <- function(x = double(), labels = NULL, na_values = NULL,
na_range = NULL, label = NULL) {
x <- vec_data(x)
na_values <- vec_cast_named(na_values, x, x_arg = "na_values", to_arg = "x")
labelled <- labelled(x, labels = labels, label = label)
new_labelled_spss(
vec_data(labelled),
labels = attr(labelled, "labels"),
na_values = na_values,
na_range = na_range,
label = attr(labelled, "label", exact = TRUE)
)
}
new_labelled_spss <- function(x, labels, na_values, na_range, label) {
if (!is.null(na_values) && any(is.na(na_values))) {
cli_abort("{.arg na_values} can not contain missing values.")
}
if (!is.null(na_range)) {
type_ok <- (is.character(x) && is.character(na_range)) ||
(is.numeric(x) && is.numeric(na_range))
if (!type_ok || length(na_range) != 2) {
cli_abort("{.arg na_range} must be a vector of length two the same type as {.arg x}.")
}
if (any(is.na(na_range))) {
cli_abort("{.arg na_range} can not contain missing values.")
}
if (na_range[1] >= na_range[2]) {
cli_abort("{.arg na_range} must be in ascending order.")
}
}
new_labelled(x,
labels = labels,
label = label,
na_values = na_values,
na_range = na_range,
class = "haven_labelled_spss"
)
}
#' @export
vec_ptype_full.haven_labelled_spss <- function(x, ...) {
paste0("labelled_spss<", vec_ptype_full(vec_data(x)), ">")
}
#' @export
vec_ptype_abbr.haven_labelled_spss <- function(x, ...) {
paste0(vec_ptype_abbr(vec_data(x)), "+lbl")
}
#' @export
obj_print_footer.haven_labelled_spss <- function(x, ...) {
na_values <- attr(x, "na_values")
if (!is.null(na_values)) {
cat_line("Missing values: ", paste(na_values, collapse = ", "))
}
na_range <- attr(x, "na_range")
if (!is.null(na_range)) {
cat_line("Missing range: [", paste(na_range, collapse = ", "), "]")
}
NextMethod()
}
#' @export
is.na.haven_labelled_spss <- function(x) {
miss <- NextMethod()
val <- vec_data(x)
na_values <- attr(x, "na_values")
if (!is.null(na_values)) {
miss <- miss | val %in% na_values
}
na_range <- attr(x, "na_range")
if (!is.null(na_range)) {
miss <- miss | (val >= na_range[1] & val <= na_range[2])
}
miss
}
# Type system -------------------------------------------------------------
# # Import to avoid R CMD check NOTE
# #' @importFrom methods setOldClass
# setOldClass(c("haven_labelled_spss", "haven_labelled", "vctrs_vctr"))
#' @export
vec_ptype2.double.haven_labelled_spss <- function(x, y, ...) {
data_type <- vec_ptype2(x, vec_data(y), ...)
new_labelled_spss(
data_type,
labels = vec_cast_named(attr(y, "labels"), data_type),
na_values = vec_cast(attr(y, "na_values"), data_type),
na_range = attr(y, "na_range"),
label = attr(y, "label", exact = TRUE)
)
}
#' @export
vec_ptype2.integer.haven_labelled_spss <- vec_ptype2.double.haven_labelled_spss
#' @export
vec_ptype2.character.haven_labelled_spss <- vec_ptype2.double.haven_labelled_spss
#' @export
vec_ptype2.haven_labelled_spss.double <- function(x, y, ...) vec_ptype2(y, x, ...)
#' @export
vec_ptype2.haven_labelled_spss.integer <- vec_ptype2.haven_labelled_spss.double
#' @export
vec_ptype2.haven_labelled_spss.character <- vec_ptype2.haven_labelled_spss.double
#' @export
vec_ptype2.haven_labelled_spss.haven_labelled_spss <- function(x, y, ..., x_arg = "", y_arg = "") {
# Use x as the prototype if the input vectors have matching metadata
if (identical(attributes(x), attributes(y))) {
return(x)
}
data_type <- vec_ptype2(vec_data(x), vec_data(y), ..., x_arg = x_arg, y_arg = y_arg)
# Prefer labels from LHS
x_labels <- vec_cast_named(attr(x, "labels"), data_type, x_arg = x_arg)
y_labels <- vec_cast_named(attr(y, "labels"), data_type, x_arg = y_arg)
labels <- combine_labels(x_labels, y_labels, x_arg, y_arg)
# Prefer labels from LHS
label <- attr(x, "label", exact = TRUE) %||% attr(y, "label", exact = TRUE)
x_na_values <- vec_cast(attr(x, "na_values"), data_type, x_arg = x_arg)
y_na_values <- vec_cast(attr(y, "na_values"), data_type, x_arg = y_arg)
# Ignore user defined missings and return a standard haven_labelled if
# there are mismatches between the missing attributes
if (!identical(x_na_values, y_na_values) ||
!identical(attr(x, "na_range"), attr(y, "na_range"))) {
new_labelled(data_type, labels = labels, label = label)
} else {
new_labelled_spss(
data_type,
labels = labels,
na_values = x_na_values,
na_range = attr(x, "na_range"),
label = label
)
}
}
#' @export
vec_ptype2.haven_labelled_spss.haven_labelled <- vec_ptype2.haven_labelled_spss.haven_labelled_spss
#' @export
vec_ptype2.haven_labelled.haven_labelled_spss <- vec_ptype2.haven_labelled_spss.haven_labelled_spss
#' @export
vec_cast.double.haven_labelled_spss <- function(x, to, ...) vec_cast(vec_data(x), to)
#' @export
vec_cast.integer.haven_labelled_spss <- function(x, to, ...) vec_cast(vec_data(x), to)
#' @export
vec_cast.character.haven_labelled_spss <- function(x, to, ...) {
if (is.character(x)) {
vec_cast(vec_data(x), to, ...)
} else {
stop_incompatible_cast(x, to, ...)
}
}
#' @export
vec_cast.haven_labelled_spss.haven_labelled_spss <- function(x, to, ..., x_arg = "", to_arg = "") {
# Don't perform any processing if the input vectors have matching metadata
if (identical(attributes(x), attributes(to))) {
return(x)
}
out_data <- vec_cast(vec_data(x), vec_data(to), ..., x_arg = x_arg, to_arg = to_arg)
x_labels <- attr(x, "labels")
to_labels <- attr(to, "labels")
out_labels <- to_labels %||% x_labels
x_na_values <- attr(x, "na_values")
to_na_values <- attr(to, "na_values")
x_na_range <- attr(x, "na_range")
to_na_range <- attr(to, "na_range")
out <- labelled_spss(out_data,
labels = out_labels,
na_values = to_na_values,
na_range = to_na_range,
label = attr(x, "label", exact = TRUE)
)
# do we lose tagged na values?
if (is.double(x) && !is.double(out)) {
lossy <- is_tagged_na(x)
maybe_lossy_cast(out, x, to, lossy,
x_arg = x_arg,
to_arg = to_arg,
details = "Only doubles can hold tagged na values."
)
}
# do any values become unlabelled?
if (!is.null(to_labels)) {
lossy <- x %in% x_labels[!x_labels %in% out_labels]
maybe_lossy_cast(out, x, to, lossy,
x_arg = x_arg,
to_arg = to_arg,
details = paste0("Values are labelled in `", x_arg, "` but not in `", to_arg, "`.")
)
}
# do any values switch from missing to non-missing?
if (!is.null(to_na_range) | !is.null(to_na_values)) {
lossy <- x %in% x_na_values
if (!is.null(x_na_range)) {
lossy <- lossy | (vec_data(x) >= x_na_range[1] & vec_data(x) <= x_na_range[2])
}
if (!is.null(to_na_range)) {
lossy <- lossy & !(vec_data(x) >= to_na_range[1] & vec_data(x) <= to_na_range[2])
} else if (!is.null(to_na_values)) {
lossy <- lossy & !x %in% to_na_values
}
maybe_lossy_cast(out, x, to, lossy,
x_arg = x_arg,
to_arg = to_arg,
details = paste0("Values are missing in `", x_arg, "` but not in `", to_arg, "`.")
)
}
out
}
#' @export
vec_cast.haven_labelled_spss.double <- function(x, to, ...) {
vec_cast.haven_labelled_spss.haven_labelled_spss(x, to, ...)
}
#' @export
vec_cast.haven_labelled_spss.integer <- function(x, to, ...) {
vec_cast.haven_labelled_spss.haven_labelled_spss(x, to, ...)
}
#' @export
vec_cast.haven_labelled_spss.character <- function(x, to, ...) {
vec_cast.haven_labelled_spss.haven_labelled_spss(x, to, ...)
}
#' @export
vec_cast.haven_labelled.haven_labelled_spss <- function(x, to, ...) {
vec_cast.haven_labelled.haven_labelled(x, to, ...)
}
#' @export
vec_cast.haven_labelled_spss.haven_labelled <- function(x, to, ...) {
vec_cast.haven_labelled_spss.haven_labelled_spss(x, to, ...)
}