-
Notifications
You must be signed in to change notification settings - Fork 60
/
col_types.R
694 lines (581 loc) · 19.3 KB
/
col_types.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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
#' Create column specification
#'
#' `cols()` includes all columns in the input data, guessing the column types
#' as the default. `cols_only()` includes only the columns you explicitly
#' specify, skipping the rest.
#'
#' The available specifications are: (long names in quotes and string abbreviations in brackets)
#'
#' | function | long name | short name | description |
#' | ---------- | ----------- | ---------- | ------------- |
#' | `col_logical()` | "logical" | "l" | Logical values containing only `T`, `F`, `TRUE` or `FALSE`. |
#' | `col_integer()` | "integer" | "i" | Integer numbers. |
#' | `col_big_integer()` | "big_integer" | "I" | Big Integers (64bit), requires the `bit64` package. |
#' | `col_double()` | "double", "numeric" | "d" | 64-bit double floating point numbers.
#' | `col_character()` | "character" | "c" | Character string data. |
#' | `col_factor(levels, ordered)` | "factor" | "f" | A fixed set of values. |
#' | `col_date(format = "")` | "date" | "D" | Calendar dates formatted with the locale's `date_format`. |
#' | `col_time(format = "")` | "time" | "t" | Times formatted with the locale's `time_format`. |
#' | `col_datetime(format = "")` | "datetime", "POSIXct" | "T" | ISO8601 date times. |
#' | `col_number()` | "number" | "n" | Human readable numbers containing the `grouping_mark` |
#' | `col_skip()` | "skip", "NULL" | "_", "-" | Skip and don't import this column. |
#' | `col_guess()` | "guess", "NA" | "?" | Parse using the "best" guessed type based on the input. |
#'
#' @param ... Either column objects created by `col_*()`, or their abbreviated
#' character names (as described in the `col_types` argument of
#' [vroom()]). If you're only overriding a few columns, it's
#' best to refer to columns by name. If not named, the column types must match
#' the column names exactly. In `col_*()` functions these are stored in the
#' object.
#' @param .default Any named columns not explicitly overridden in `...`
#' will be read with this column type.
#' @param .delim The delimiter to use when parsing. If the `delim` argument
#' used in the call to `vroom()` it takes precedence over the one specified in
#' `col_types`.
#' @export
#' @aliases col_types
#' @examples
#' cols(a = col_integer())
#' cols_only(a = col_integer())
#'
#' # You can also use the standard abbreviations
#' cols(a = "i")
#' cols(a = "i", b = "d", c = "_")
#'
#' # Or long names (like utils::read.csv)
#' cols(a = "integer", b = "double", c = "skip")
#'
#' # You can also use multiple sets of column definitions by combining
#' # them like so:
#'
#' t1 <- cols(
#' column_one = col_integer(),
#' column_two = col_number())
#'
#' t2 <- cols(
#' column_three = col_character())
#'
#' t3 <- t1
#' t3$cols <- c(t1$cols, t2$cols)
#' t3
cols <- function(..., .default = col_guess(), .delim = NULL) {
col_types <- rlang::list2(...)
is_character <- vapply(col_types, is.character, logical(1))
col_types[is_character] <- lapply(col_types[is_character], col_concise)
if (is.character(.default)) {
.default <- col_concise(.default)
}
col_spec(col_types, .default, .delim)
}
#' @export
#' @rdname cols
cols_only <- function(...) {
cols(..., .default = col_skip())
}
# col_spec ----------------------------------------------------------------
col_spec <- function(col_types, default = col_guess(), delim) {
stopifnot(is.list(col_types))
stopifnot(is.collector(default))
is_collector <- vapply(col_types, is.collector, logical(1))
if (any(!is_collector)) {
stop("Some `col_types` are not S3 collector objects: ",
paste(which(!is_collector), collapse = ", "), call. = FALSE)
}
structure(
list(
cols = col_types,
default = default,
delim = delim
),
class = "col_spec"
)
}
is.col_spec <- function(x) inherits(x, "col_spec")
#' Coerce to a column specification
#'
#' This is most useful for generating a specification using the short form or coercing from a list.
#'
#' @param x Input object
#' @keywords internal
#' @examples
#' as.col_spec("cccnnn")
#' @export
as.col_spec <- function(x) UseMethod("as.col_spec")
#' @export
as.col_spec.character <- function(x) {
if (is_named(x)) {
return(as.col_spec(as.list(x)))
}
letters <- strsplit(x, "")[[1]]
col_spec(lapply(letters, col_concise), col_guess(), delim = NULL)
}
#' @export
as.col_spec.NULL <- function(x) {
col_spec(list(), delim = NULL)
}
#' @export
as.col_spec.list <- function(x) {
do.call(cols, x)
}
#' @export
as.col_spec.col_spec <- function(x) {
if (!"delim" %in% names(x)) {
x["delim"] <- list(NULL)
}
x
}
#' @export
as.col_spec.default <- function(x) {
stop("`col_types` must be NULL, a list or a string", call. = FALSE)
}
# Conditionally exported in zzz.R
# @export
print.col_spec <- function(x, n = Inf, condense = NULL, colour = crayon::has_color(), ...) {
cat(format.col_spec(x, n = n, condense = condense, colour = colour, ...))
invisible(x)
}
#' @description
#' `cols_condense()` takes a spec object and condenses its definition by setting
#' the default column type to the most frequent type and only listing columns
#' with a different type.
#' @rdname spec
#' @export
cols_condense <- function(x) {
types <- vapply(x$cols, function(xx) class(xx)[[1]], character(1))
counts <- table(types)
most_common <- names(counts)[counts == max(counts)][[1]]
x$default <- x$cols[types == most_common][[1]]
x$cols <- x$cols[types != most_common]
x
}
# Conditionally exported in zzz.R
# @export
format.col_spec <- function(x, n = Inf, condense = NULL, colour = crayon::has_color(), ...) {
if (n == 0) {
return("")
}
# condense if cols >= n
condense <- condense %||% (length(x$cols) >= n)
if (isTRUE(condense)) {
x <- cols_condense(x)
}
# truncate to minumum of n or length
cols <- x$cols[seq_len(min(length(x$cols), n))]
default <- NULL
if (inherits(x$default, "collector_guess")) {
fun_type <- "cols"
} else if (inherits(x$default, "collector_skip")) {
fun_type <- "cols_only"
} else {
fun_type <- "cols"
type <- sub("^collector_", "", class(x$default)[[1]])
default <- paste0(".default = col_", type, "()")
}
delim <- x$delim
if (!is.null(delim) && nzchar(delim)) {
delim <- paste0('.delim = ', double_quote(delim), '')
}
cols_args <- c(
default,
vapply(seq_along(cols),
function(i) {
col_funs <- sub("^collector_", "col_", class(cols[[i]])[[1]])
args <- vapply(cols[[i]], deparse2, character(1), sep = "\n ")
args <- paste(names(args), args, sep = " = ", collapse = ", ")
col_funs <- paste0(col_funs, "(", args, ")")
col_funs <- colourise_cols(col_funs, colour)
col_names <- names(cols)[[i]] %||% ""
# Need to handle unnamed columns and columns with non-syntactic names
named <- col_names != ""
non_syntactic <- !is_syntactic(col_names) & named
col_names[non_syntactic] <- paste0("`", gsub("`", "\\\\`", col_names[non_syntactic]), "`")
out <- paste0(col_names, " = ", col_funs)
out[!named] <- col_funs[!named]
out
},
character(1)
),
delim
)
if (length(x$cols) == 0 && length(cols_args) == 0) {
return(paste0(fun_type, "()\n"))
}
out <- paste0(fun_type, "(\n ", paste(collapse = ",\n ", cols_args))
if (length(x$cols) > n) {
out <- paste0(out, "\n # ... with ", length(x$cols) - n, " more columns")
}
out <- paste0(out, "\n)\n")
out
}
colourise_cols <- function(cols, colourise = crayon::has_color()) {
if (!isTRUE(colourise)) {
return(cols)
}
fname <- sub("[(].*", "", cols)
for (i in seq_along(cols)) {
cols[[i]] <- switch(fname,
col_skip = ,
col_guess = cols[[i]],
col_character = ,
col_factor = crayon::red(cols[[i]]),
col_logical = crayon::yellow(cols[[i]]),
col_double = ,
col_integer = ,
col_number = crayon::green(cols[[i]]),
col_date = ,
col_datetime = ,
col_time = crayon::blue(cols[[i]])
)
}
cols
}
# This allows str() on a tibble object to print a little nicer.
# Conditionally exported in zzz.R
# @export
str.col_spec <- function(object, ..., indent.str = "") {
# Split the formatted column spec into strings
specs <- strsplit(format(object), "\n")[[1]]
cat(sep = "",
"\n",
# Append the current indentation string to the specs
paste(indent.str, specs, collapse = "\n"),
"\n")
}
#' Examine the column specifications for a data frame
#'
#' `spec()` extracts the full column specification from a tibble
#' created by readr.
#'
#' @family parsers
#' @param x The data frame object to extract from
#' @return A col_spec object.
#' @export
#' @examples
#' df <- vroom(vroom_example("mtcars.csv"))
#' s <- spec(df)
#' s
#'
#' cols_condense(s)
spec <- function(x) {
stopifnot(inherits(x, "tbl_df"))
attr(x, "spec")
}
col_concise <- function(x) {
switch(x,
"_" = ,
"skip" =,
"NULL" =,
"-" = col_skip(),
"NA" = ,
"?" = col_guess(),
character =,
c = col_character(),
factor =,
f = col_factor(),
double =,
numeric =,
d = col_double(),
integer =,
i = col_integer(),
big_integer =,
I = col_big_integer(),
logical = ,
l = col_logical(),
number = ,
n = col_number(),
date = ,
Date = ,
D = col_date(),
datetime = ,
POSIXct = ,
T = col_datetime(),
time =,
t = col_time(),
stop("Unknown shortcut: ", x, call. = FALSE)
)
}
vroom_enquo <- function(x) {
if (rlang::quo_is_call(x, "c") || rlang::quo_is_call(x, "list")) {
return(rlang::as_quosures(rlang::get_expr(x)[-1], rlang::get_env(x)))
}
x
}
vroom_select <- function(x, col_select, id) {
spec <- attr(x, "spec")
# Drop any NULL columns
is_null <- vapply(x, is.null, logical(1))
x[is_null] <- NULL
# reorder and rename columns
if (inherits(col_select, "quosures") || !rlang::quo_is_null(col_select)) {
if (inherits(col_select, "quosures")) {
vars <- tidyselect::vars_select(c(names(spec(x)$cols), id), !!!col_select)
} else {
vars <- tidyselect::vars_select(c(names(spec(x)$cols), id), !!col_select)
}
if (!is.null(id) && !id %in% vars) {
names(id) <- id
vars <- c(id, vars)
}
# This can't be just names(x) as we need to have skipped
# names as well to pass to vars_select()
x <- x[vars]
names(x) <- names(vars)
}
attr(x, "spec") <- spec
x
}
col_types_standardise <- function(spec, num_cols, col_names, col_select, name_repair) {
if (num_cols == 0) {
if (length(spec$cols) > 0) {
num_cols <- length(spec$cols)
} else if (length(col_names) > 0) {
num_cols <- length(col_names)
}
}
if (length(col_names) == 0) {
col_names <- make_names(NULL, num_cols)
}
col_names <- vctrs::vec_as_names(col_names, repair = name_repair)
type_names <- names(spec$cols)
if (length(spec$cols) == 0) {
# no types specified so use defaults
spec$cols <- rep(list(spec$default), num_cols)
names(spec$cols) <- col_names[seq_along(spec$cols)]
} else if (is.null(type_names)) {
# unnamed types & names guessed from header: match exactly
if (num_cols < length(spec$cols)) {
spec$cols <- spec$cols[seq_len(num_cols)]
} else {
spec$cols <- c(spec$cols, rep(list(spec$default), num_cols - length(spec$cols)))
}
names(spec$cols) <- col_names[seq_along(spec$cols)]
} else {
# named types
if (num_cols > length(col_names)) {
col_names <- make_names(col_names, num_cols)
}
bad_types <- !(type_names %in% col_names)
if (any(bad_types)) {
rlang::warn(paste0("The following named parsers don't match the column names: ",
paste0(type_names[bad_types], collapse = ", ")), class = "vroom_mismatched_column_name")
spec$cols <- spec$cols[!bad_types]
type_names <- type_names[!bad_types]
}
default_types <- !(col_names %in% type_names)
if (any(default_types)) {
defaults <- rep(list(spec$default), sum(default_types))
names(defaults) <- col_names[default_types]
spec$cols[names(defaults)] <- defaults
}
spec$cols <- spec$cols[col_names]
}
if (inherits(col_select, "quosures") || !rlang::quo_is_null(col_select)) {
if (inherits(col_select, "quosures")) {
to_keep <- names(spec$cols) %in% tidyselect::vars_select(names(spec$cols), !!!col_select, .strict = FALSE)
} else {
to_keep <- names(spec$cols) %in% tidyselect::vars_select(names(spec$cols), !!col_select, .strict = FALSE)
}
spec$cols[!to_keep] <- rep(list(col_skip()), sum(!to_keep))
}
# Set the names, ignoring skipped columns
kept <- !vapply(spec$cols, inherits, logical(1), "collector_skip")
# Fill the column names if they are shorter than what is kept.
if (length(col_names) == length(spec$cols)) {
names(spec$cols)[kept] <- col_names[kept]
} else if (length(col_names) == sum(kept)) {
names(spec$cols)[kept] <- col_names
} else {
col_names <- make_names(col_names, sum(kept))
names(spec$cols)[kept] <- col_names
}
spec
}
#' Guess the type of a vector
#'
#' @inheritParams readr::guess_parser
#' @examples
#' # Logical vectors
#' guess_type(c("FALSE", "TRUE", "F", "T"))
#' # Integers and doubles
#' guess_type(c("1","2","3"))
#' guess_type(c("1.6","2.6","3.4"))
#' # Numbers containing grouping mark
#' guess_type("1,234,566")
#' # ISO 8601 date times
#' guess_type(c("2010-10-10"))
#' guess_type(c("2010-10-10 01:02:03"))
#' guess_type(c("01:02:03 AM"))
#' @export
guess_type <- function(x, na = c("", "NA"), locale = default_locale(), guess_integer = FALSE) {
type <- guess_type_(x, na = na, locale = locale, guess_integer = guess_integer)
get(paste0("col_", type), asNamespace("vroom"))()
}
guess_parser <- function(x, na = c("", "NA"), locale = default_locale(), guess_integer = FALSE) {
guess_type_(x, na = na, locale = locale, guess_integer = guess_integer)
}
show_dims <- function(x) {
cli_block(class = "vroom_dim_message", {
cli::cli_text("
{.strong Rows: }{.val {NROW(x)}}
{.strong Columns: }{.val {NCOL(x)}}
")
})
}
collector_value <- function(x, ...) {
UseMethod("collector_value")
}
#' @export
collector_value.collector_character <- function(x, ...) { character() }
#' @export
collector_value.collector_double <- function(x, ...) { numeric() }
#' @export
collector_value.collector_integer <- function(x, ...) { integer() }
#' @export
collector_value.collector_numeric <- function(x, ...) { numeric() }
#' @export
collector_value.collector_logical <- function(x, ...) { logical() }
#' @export
collector_value.collector_factor <- function(x, ...) { factor() }
#' @export
collector_value.collector_datetime <- function(x, ...) { as.POSIXct(double()) }
#' @export
collector_value.collector_date <- function(x, ...) { as.Date(double()) }
#' @export
collector_value.collector_time <- function(x, ...) { hms::hms() }
#' @export
collector_value.collector_guess <- function(x, ...) { character() }
#' @importFrom crayon silver
#' @importFrom glue double_quote
#' @export
summary.col_spec <- function(object, width = getOption("width"), locale = default_locale(), ...) {
if (length(object$cols) == 0) {
return(invisible(object))
}
type_map <- c("collector_character" = "chr", "collector_double" = "dbl",
"collector_integer" = "int", "collector_number" = "num", "collector_logical" = "lgl",
"collector_factor" = "fct", "collector_datetime" = "dttm", "collector_date" = "date",
"collector_time" = "time",
"collector_guess" = "???")
col_types <- vapply(object$cols, function(x) class(x)[[1]], character(1))
col_types <- droplevels(factor(type_map[col_types], levels = unname(type_map)))
type_counts <- table(col_types)
n <- length(type_counts)
types <- format(vapply(names(type_counts), color_type, character(1)))
counts <- format(glue::glue("({type_counts})"), justify = "right")
col_width <- min(width - (crayon::col_nchar(types) + nchar(counts) + 4))
columns <- vapply(split(names(object$cols), col_types), function(x) glue::glue_collapse(x, ", ", width = col_width), character(1))
fmt_num <- function(x) {
prettyNum(x, big.mark = locale$grouping_mark, decimal.mark = locale$decimal_mark)
}
delim <- object$delim %||% ""
txt <- glue::glue(
.transformer = collapse_transformer(sep = "\n"),
entries = glue::glue("{format(types)} {counts}: {columns}"),
'
{if (nzchar(delim)) paste(bold("Delimiter:"), double_quote(delim)) else ""}
{entries*}
')
cli_block(class = "vroom_spec_message", {
cli::cli_h1("Column specification")
cli::cli_verbatim(txt)
})
invisible(object)
}
show_col_types <- function(x, locale) {
show_dims(x)
summary(spec(x), locale = locale)
cli_block(class = "vroom_spec_message", {
cli::cli_verbatim("\n\n")
cli::cli_alert_info("Use {.fn spec} to retrieve the full column specification for this data.")
cli::cli_alert_info("Specify the column types or set {.arg show_col_types = FALSE} to quiet this message.")
})
}
cli_block <- function(expr, class = NULL, type = rlang::inform) {
msg <- ""
withCallingHandlers(
expr,
message = function(x) {
msg <<- paste0(msg, x$message)
invokeRestart("muffleMessage")
}
)
msg <- sub("^\n", "", msg)
msg <- sub("\n+$", "", msg)
type(msg, class = class)
}
color_type <- function(type) {
switch(type,
chr = ,
fct = crayon::red(type),
lgl = crayon::yellow(type),
dbl = ,
int = ,
num = crayon::green(type),
date = ,
dttm = ,
time = crayon::blue(type),
"???" = type
)
}
#' @rdname cols
#' @export
col_logical <- function(...) {
collector("logical", ...)
}
#' @rdname cols
#' @export
col_integer <- function(...) {
collector("integer", ...)
}
#' @rdname cols
#' @export
col_big_integer <- function(...) {
collector("big_integer", ...)
}
#' @rdname cols
#' @export
col_double <- function(...) {
collector("double", ...)
}
#' @rdname cols
#' @export
col_character <- function(...) {
collector("character", ...)
}
#' @rdname cols
#' @export
col_skip <- function(...) {
collector("skip", ...)
}
#' @rdname cols
#' @export
col_number <- function(...) {
collector("number", ...)
}
#' @rdname cols
#' @export
col_guess <- function(...) {
collector("guess", ...)
}
#' @inheritParams readr::col_factor
#' @rdname cols
#' @export
col_factor <- function(levels = NULL, ordered = FALSE, include_na = FALSE, ...) {
collector("factor", levels = levels, ordered = ordered, include_na = include_na, ...)
}
#' @inheritParams readr::col_datetime
#' @rdname cols
#' @export
col_datetime <- function(format = "", ...) {
collector("datetime", format = format, ...)
}
#' @rdname cols
#' @export
col_date <- function(format = "", ...) {
collector("date", format = format, ...)
}
#' @rdname cols
#' @export
col_time <- function(format = "", ...) {
collector("time", format = format, ...)
}