save_tex_value: Save values to a tex file

In Ori-Shoham/savetolyx: Manage Values Calculated in R for Projects Written in Tex

Save values to a tex file

Description

save_tex_value saves pairs of values and names of commands to be associated with them to a special formatted '.tex' file.

Usage

save_tex_value(
  values,
  names,
  file_name,
  path = NULL,
  translate = TRUE,
  digits = 2,
  percent = FALSE,
  accuracy = 1,
  override = TRUE
)

Arguments

values	Numeric, character or logical vector of values to be saved. Logical values will be saved as character.
names	Character vector of names. Each name must be unique and can consist of letters only.
file_name	File name to create on disk. file_name should have either a .tex extension or no extension at all.
path	Path to the directory to save the file to. path and file_name are combined to create fully qualified file name. If Null and file_name does not specify a full file name defaults to working directory.
translate	Logical indicating whether to save values in LaTeX format. See latexTranslate.
digits	The desired number of digits after the decimal point for numeric non-percent values. Defaults to 2 digits after the decimal point.
percent	Logical scalar or vector. If values is a numeric vector percent indicates whether to save values as percents or as is. If you want only a subset of values to be saved as percents percent should be a logical vector indicating the positions of these values.
accuracy	A number to round percent values to. Use (e.g.) 0.01 to show 2 decimal places of precision. Defaults to 1 i.e round to the nearest integer.
override	Logical indicating whether to override values if a value with the same name already exits in the file.

Examples

## Not run: 
file <- tempfile()
save_tex_value(values = 1:3, names = c("a","b","c"), file_name = file)

# Save percent values to the same file
save_tex_value(values = 0.5, names = "halfPer", file_name = file, percent = TRUE)

# override "a" with a different value
a <- rnorm(1)
save_tex_value(values = a, names = "a", file_name = file, digits = 4)

# delete file with base::unlink()
unlink(paste0(file,".tex"))


## End(Not run)

Ori-Shoham/savetolyx documentation built on Oct. 29, 2022, 3:42 a.m.