Write a Q-View object to disk — write

Usage

write_qview_xlsx(
  qv,
  path,
  template = NULL,
  overwrite = FALSE,
  call = rlang::caller_env()
)

write_qview_csv(qv, path, template = NULL, call = rlang::caller_env())

write_qview_rds(qv, path, overwrite = FALSE, call = rlang::caller_env())

qview_to_xlsx(
  qv,
  path,
  template = NULL,
  overwrite = FALSE,
  call = rlang::caller_env()
)

qview_to_csv_dir(qv, dir, template = NULL, call = rlang::caller_env())

Arguments

qv: A qview object from read_qview().
path: Output path. For write_qview_xlsx() / write_qview_rds() this is a single file path; for write_qview_csv() it is the output directory (created if it does not exist).
template: Optional plate-template tibble (from read_qview_template()) to include as an extra sheet / file.
overwrite: Logical. If FALSE (the default), an existing destination triggers an error; set to TRUE to replace it. Ignored by write_qview_csv() (it only adds files).
call: The execution environment of the calling function. Used for error reporting; experts only.
dir: Deprecated alias for path accepted by qview_to_csv_dir(). Use path instead.

Value

qv, invisibly, to support pipelines.

Details

Three writers, one for each common destination. All return the input qv invisibly so they compose with the pipe.

write_qview_xlsx() – one sheet per parsed table.
write_qview_csv() – one CSV per parsed table inside a directory.
write_qview_rds() – a single .rds containing the full qview object (lossless, the only round-trippable format).

Examples

if (FALSE) { # \dontrun{
  qv <- read_qview("plate.Q-View")
  qv |>
    write_qview_xlsx("plate.xlsx") |>
    write_qview_csv("plate_csv/")  |>
    write_qview_rds("plate.rds")
} # }