File: stri_write_lines.Rd

package info (click to toggle)
r-cran-stringi 1.7.12-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 39,772 kB
  • sloc: cpp: 482,349; ansic: 51,900; perl: 471; makefile: 9; sh: 1
file content (54 lines) | stat: -rw-r--r-- 1,487 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/files.R
\name{stri_write_lines}
\alias{stri_write_lines}
\title{Write Text Lines to a Text File}
\usage{
stri_write_lines(
  str,
  con,
  encoding = "UTF-8",
  sep = ifelse(.Platform$OS.type == "windows", "\\r\\n", "\\n"),
  fname = con
)
}
\arguments{
\item{str}{character vector with data to write}

\item{con}{name of the output file or a connection object
(opened in the binary mode)}

\item{encoding}{output encoding, \code{NULL} or \code{''} for
the current default one}

\item{sep}{newline separator}

\item{fname}{deprecated alias of \code{con}}
}
\value{
This function returns nothing noteworthy.
}
\description{
Writes a text file is such a way that each element of a given
character vector becomes a separate text line.
}
\details{
It is a substitute for the \R \code{\link{writeLines}} function,
with the ability to easily re-encode the output.

We suggest using the UTF-8 encoding for all text files:
thus, it is the default one for the output.
}
\seealso{
The official online manual of \pkg{stringi} at \url{https://stringi.gagolewski.com/}

Gagolewski M., \pkg{stringi}: Fast and portable character string processing in R, \emph{Journal of Statistical Software} 103(2), 2022, 1-59, \doi{10.18637/jss.v103.i02}

Other files: 
\code{\link{stri_read_lines}()},
\code{\link{stri_read_raw}()}
}
\concept{files}
\author{
\href{https://www.gagolewski.com/}{Marek Gagolewski} and other contributors
}