vroom_lines: Read lines from a file

Description Usage Arguments Examples

View source: R/vroom_lines.R

Description

vroom_lines() is similar to readLines(), however it reads the lines lazily like vroom(), so operations like length(), head(), tail() and sample() can be done much more efficiently without reading all the data into R.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
vroom_lines(
  file,
  n_max = Inf,
  skip = 0,
  locale = default_locale(),
  altrep = TRUE,
  altrep_opts = deprecated(),
  num_threads = vroom_threads(),
  progress = vroom_progress()
)

Arguments

file

path to a local file.

n_max

Maximum number of records to read.

skip

Number of lines to skip before reading data.

locale

The locale controls defaults that vary from place to place. The default locale is US-centric (like R), but you can use locale() to create your own locale that controls things like the default time zone, encoding, decimal mark, big mark, and day/month names.

altrep

Control which column types use Altrep representations, either a character vector of types, TRUE or FALSE. See vroom_altrep() for for full details.

altrep_opts \Sexpr[results=rd, stage=render]{lifecycle::badge("deprecated")}
num_threads

Number of threads to use when reading and materializing vectors. If your data contains embedded newlines (newlines within fields) you must use num_threads = 1 to read the data properly.

progress

Display a progress bar? By default it will only display in an interactive session and not while knitting a document. The display is updated every 50,000 values and will only display if estimated reading time is 5 seconds or more. The automatic progress bar can be disabled by setting option readr.show_progress to FALSE.

Examples

1
2
3
4
5
6
lines <- vroom_lines(vroom_example("mtcars.csv"))

length(lines)
head(lines, n = 2)
tail(lines, n = 2)
sample(lines, size = 2)

vroom documentation built on Aug. 27, 2020, 9:07 a.m.