write_file: Write files based on the extension

In connector: Streamlining Data Access in Clinical Research

Write files based on the extension

Description

write_file() is the backbone of all write_cnt() methods, where files are written to a connector. The function is a wrapper around write_ext() where the appropriate function to write the file is chosen depending on the file extension.

write_ext() has methods defined for the following file extensions:

• txt: readr::write_lines()

• csv: readr::write_csv()

• parquet: arrow::write_parquet()

• rds: readr::write_rds()

• sas7bdat: haven::write_sas()

• yml/yaml: yaml::write_yaml()

• json: jsonlite::write_json()

• excel: writexl::write_xlsx()

Usage

write_file(x, file, overwrite = FALSE, ...)

write_ext(file, x, ...)

## S3 method for class 'txt'
write_ext(file, x, ...)

## S3 method for class 'csv'
write_ext(file, x, delim = ",", ...)

## S3 method for class 'parquet'
write_ext(file, x, ...)

## S3 method for class 'rds'
write_ext(file, x, ...)

## S3 method for class 'xpt'
write_ext(file, x, ...)

## S3 method for class 'yml'
write_ext(file, x, ...)

## S3 method for class 'json'
write_ext(file, x, ...)

## S3 method for class 'xlsx'
write_ext(file, x, ...)

Arguments

x	Object to write
file	character() Path to write the file.
overwrite	logical Overwrite existing content if it exists.
...	Other parameters passed on the functions behind the methods for each file extension.
delim	character() Delimiter to use. Default is ",".

Details

Note that write_file() will not overwrite existing files unless overwrite = TRUE, while all methods for write_ext() will overwrite existing files by default.

Value

write_file(): invisible() file.

write_ext(): The return of the functions behind the individual methods.

Examples

# Write CSV file
temp_csv <- tempfile("iris", fileext = ".csv")
write_file(iris, temp_csv)

connector documentation built on June 8, 2025, 11:36 a.m.