ltx_capture_output: Capture and format output as LaTeX-compatible text

In AndreSjuve/texaid: Tweak Latex code for regression tables

Capture and format output as LaTeX-compatible text

Description

The ltx_capture_output function captures the output of an object or expression and formats it for LaTeX compatibility. This function can be used to collect output that may be written over multiple lines and format it as a character vector with appropriate line breaks for LaTeX output.

Usage

ltx_capture_output(x)

Arguments

x	An object or expression whose output you wish to capture. This can be a single object or multiple lines of text.

Details

If x contains multiple elements (e.g., a vector or list), the function will concatenate the elements using line breaks (⁠\n⁠) to ensure proper formatting when the content is rendered as LaTeX. For single-element input, the output will simply be captured and returned invisibly.

The function relies on utils::capture.output() to handle capturing the output of expressions and converting them into a character vector. The use of cat() ensures that multi-line elements are appropriately formatted.

Value

A character vector containing the captured output, formatted with line breaks if necessary. The result is returned invisibly, so it can be used without printing the output directly.

See Also

utils::capture.output()

Examples

## Not run: 
# Example with multiple lines
x <- c("Line 1", "Line 2", "Line 3")
ltx_capture_output(x)

# Example with a single object
y <- "Single Line"
ltx_capture_output(y)

## End(Not run)

AndreSjuve/texaid documentation built on Oct. 20, 2024, 6:17 a.m.