Concatenate textab blocks vertically.

Description

Concatenate textab blocks vertically.

Usage

## S3 method for class 'tt_'
upper_block + lower_block

Arguments

Value

The output is a textab block, formed by vertically concatenating the two provided textab blocks.

Examples

# define some textab blocks
first_block = TexRow(c(1,2))
first_block

second_block = TexRow(3)
second_block

third_block = TexRow(4)
third_block

# concatenate two blocks vertically
first_block + second_block

# concatenate three blocks vertically
first_block + second_block + third_block

# concatenate both horizontally and vertically
# note: horizontal concatenation takes precedence over vertical concatenation
first_block + second_block / third_block

Concatenate textab blocks horizontally (side-by-side).

Description

Concatenate textab blocks horizontally (side-by-side).

Usage

## S3 method for class 'tt_'
left_block / right_block

Arguments

Value

The output is a textab block, formed by horizontally concatenating the two provided textab blocks.

Examples

# define some textab blocks
first_block = TexRow(c(1,2))
first_block

second_block = TexRow(3)
second_block

third_block = TexRow(4)
third_block

# concatenate two blocks horizontally
first_block / second_block

# concatenate three blocks horizontally
first_block / second_block / third_block

# concatenate both horizontally and vertically
# note: horizontal concatenation takes precedence over vertical concatenation
first_block + second_block / third_block

Create one (or many) partial midrule(s).

Description

Create one (or many) partial midrule(s).

Usage

TexMidrule(rule_list = NULL)

Arguments

Value

The output is a textab block.

Examples

# set up two textab blocks:
block1 = TexRow(c("hello","world","block"))
block2 = TexRow(c(5.081, 2.345, 6.789), dec=1)

# add a full midrule between the two blocks
block1 + TexMidrule() + block2

# add a partial midrule to the first column and spanning the second-third columns:
block1 + TexMidrule(list(c(1,1), c(2,3))) + block2

This function creates a row of a LaTeX table.

Description

This function creates a row of a LaTeX table.

Usage

TexRow(
  value,
  cspan = rep(1, length(value)),
  position = "c",
  surround = "%s",
  space = 0,
  dec = 3,
  percentage = FALSE,
  dollar = FALSE,
  se = FALSE,
  pvalues = NULL
)

Arguments

Value

The output is a textab block.

Examples

# basic character row:
vec = c("hello", "world")
TexRow(vec)

# character row with LaTeX formatting:
vec = c('Hello','\\textbf{World}','$\\alpha$','$\\frac{1}{2}$')
TexRow(vec)

# basic numeric row:
vec <- c(1.0, 1.01, 1.001)
TexRow(vec)
TexRow(vec, dec = 2) # round to second decimal place

# custom formatting of numbers using surround argument:
vec = c(5.081, 2.345, 6.789)
TexRow(vec, dec = 1, surround = "{\\color{red} %s}")

# use cspan argument to merge the second and third rows:
vec = c("hello", "world")
TexRow(vec, cspan = c(1,2))
TexRow(vec, cspan = c(1,2), position = "c") # center merged columns

# concatenate blocks vertically or horizontally:
block1 = TexRow(c("hello","world","block"))
block2 = TexRow(c(5.081, 2.345, 6.789), dec=1)
block1 / block2 # horizontal
block1 + block2 # vertical

# add 3pt of vertical space between two rows using the space argument:
TexRow(c("hello", "world"), space=3) + TexRow(c('$\\alpha$','$\\frac{1}{2}$'))

Compile a tabular object to a pdf file

Description

Compile a tabular object to a pdf file

Usage

TexSave(
  tab,
  filename,
  positions,
  pretty_rules = TRUE,
  output_path = getwd(),
  stand_alone = FALSE,
  compile_tex = FALSE
)

Arguments

Value

A list containing the path to the .tex file and the name of the .tex file.

Examples

# consider the following example textab object:
tt = TexRow(c("hello", "world")) + TexRow(c(1,2))

# define the positions for each column:
pos = c("l","c")

# choose an output path:
op = tempdir()

# Save a simple .tex document containing this table:
TexSave(tab = tt, positions = pos, filename = "example1", output_path = op)

# Save the .tex document as stand-alone, which includes LaTeX headers and packages:
TexSave(tab = tt, positions = pos, filename = "example2", output_path = op, stand_alone = TRUE)

Print a textab block as a LaTeX tabular.

Description

Print a textab block as a LaTeX tabular.

Usage

## S3 method for class 'tt_block'
print(x, ...)

Arguments

Value

Print prints its argument and returns it invisibly.