write_text: Function to write a text into xml format in the correct...

In shug0131/cctu: In-House Functions for Report Writing at Cambridge Clinical Trials Unit

Function to write a text into xml format in the correct directory, and edit TableofTables

Description

Function to write a text into xml format in the correct directory, and edit TableofTables

Usage

write_text(
  X,
  number = cctu_env$number,
  clean_up = TRUE,
  directory = file.path(getOption("cctu_output", default = "Output"), "Core"),
  verbose = options()$verbose
)

Arguments

X	the character string to be saved in xml format
number	the number used to as a suffix in the output filename, and to link to TableofTables. Default is to use the value in the cctu_env package environment that is set within attach_pop.
clean_up	logical to invoke the clean_up function at the end. Defaults to TRUE
directory	where to save the figures within path or current working directory. The Output directory can be over-riden with options("cctu_output").
verbose	logical to print information on changes to the global environment or external files. Defaults to options()$verbose.

Value

writes an xml version of the input data to file text_number.xml . Edits the TableofTables object with the calling programe. No return object.

See Also

write_ggplot write_table

shug0131/cctu documentation built on Feb. 15, 2025, 3:27 p.m.