iarc_input_write: Write File to Use as IARC CRG Tools Input

View source: R/io.R

iarc_input_writeR Documentation

Write File to Use as IARC CRG Tools Input

Description

A text file is written in a fixed field format.

Usage

iarc_input_write(
  x,
  colnameset.name = tool_colnameset_names()[1],
  file = tempfile(fileext = ".txt", tmpdir = iarccrgtools::iarc_workdir_get()),
  overwrite = NULL,
  verbose = FALSE,
  fwrite_arg_list = NULL
)

write_tools_data(
  x,
  colnameset.name = tool_colnameset_names()[1],
  file = tempfile(fileext = ".txt", tmpdir = iarccrgtools::iarc_workdir_get()),
  overwrite = NULL,
  verbose = FALSE,
  fwrite_arg_list = NULL
)

Arguments

x

a data.frame

colnameset.name

one of the items returned by tool_colnameset_names

file

⁠[character]⁠ (mandatory, no default)

path where x will be written to; if the file already exists, this function prompts you whether to overwrite or not; in non-interactive use

overwrite

⁠[NULL, logical]⁠ (optional, default NULL)

  • NULL: if file already exists, user is prompted whether to overwrite; in non-interactive mode (see ?interactive) a pre-existing file causes an error

  • TRUE: any pre-existing file is overwritten without prompting

  • FALSE any pre-existing file is overwritten causes an error

verbose

⁠[logical]⁠ (mandatory, no default)

if TRUE, the function emits messages during it's run to let you know what's happening

fwrite_arg_list

⁠[NULL, list]⁠

Passed to fwf::fwf_write arg fwrite_arg_list. The following defaults are internally:

  • sep = ";"

  • dec = ","

  • quote = FALSE

  • row.names = FALSE

  • col.names = FALSE

Functions

  • write_tools_data(): Deprecated — use iarccrgtools::iarc_input_write.


WetRobot/iarccrgtools documentation built on Feb. 1, 2024, 6:33 a.m.