writeLines: Write lines to a file

View source: R/writeLines.R

writeLinesR Documentation

Write lines to a file

Description

This is a drop in replacement for base::writeLines() with restricted functionality. Compared to base::writeLines() it:

  • Only works with file paths, not connections.

  • Uses enc2utf8() to convert text() to UTF-8 before writing.

  • Uses sep unconditionally as the line ending, regardless of platform.

  • The useBytes argument is ignored, with a warning.

Usage

writeLines(text, con, sep = "\n", useBytes)

Arguments

text

A character vector to write

con

A character string of the path to a file. Throws an error if a connection object is passed.

sep

The end of line characters to use between lines.

useBytes

Ignored, with a warning.

Value

The UTF-8 encoded input text (invisibly).

See Also

readLines()

Examples

tf <- tempfile()

writeLines(rownames(mtcars), tf)

# Trying to use connections throws an error
con <- file(tf)
try(writeLines(con))
close(con)

# Trying to use unsupported args throws a warning
writeLines(rownames(mtcars), tf, useBytes = TRUE)

unlink(tf)

brio documentation built on May 29, 2024, 6:41 a.m.