writing_sources: Write a source to a file

In gitlab-r-packages-mirror/rock: Reproducible Open Coding Kit

Write a source to a file

Description

These functions write one or more source(s) from memory (as loaded by load_source() or load_sources() to a file.

Usage

write_source(
  x,
  output,
  encoding = rock::opts$get("encoding"),
  preventOverwriting = rock::opts$get("preventOverwriting"),
  silent = rock::opts$get("silent")
)

write_sources(
  x,
  output,
  filenamePrefix = "",
  filenameSuffix = "_written",
  encoding = rock::opts$get("encoding"),
  silent = rock::opts$get("silent")
)

Arguments

x	The source(s).
output	The filename (for rock::write_source()) or path (for rock::write_sources()) to write to.
encoding	The encoding to use.
preventOverwriting	Whether to prevent against overwriting of the file(s) to write. Set to FALSE to overwrite.
silent	Whether to be chatty or quiet.
filenamePrefix, filenameSuffix	Optional prefixes or suffixes to pre- or append to the filenames when writing the files.

Value

Invisibly, the input (x), to enable chaining in pipes.

Examples

### Get path to example source
examplePath <-
  system.file("extdata", package="rock");

### Get a path to one example file
exampleFile <-
  file.path(examplePath, "example-1.rock");

### Get a temporary file to write to
tempFile <- tempfile(fileext = ".rock")

### Pipe chain to load the example source; add a code;
### and write the result to disk
loadedSource <-

  rock::load_source(exampleFile) |>

  rock::code_source(c("Lorem Ipsum" = "lorumIpsum")) |>

  rock::write_source(tempFile);

gitlab-r-packages-mirror/rock documentation built on Dec. 3, 2024, 5:40 p.m.