star_add_column_numbers: Insert column numbrers in a table

In ChandlerLutz/starpolishr: polish stargazer (latex) files

Insert column numbrers in a table

Description

Currently this only works for latex. This function is helpful when creating a stargazer table from matrix output as stargazer does not automatically use column numbers for matrices

Usage

star_add_column_numbers(
  star,
  insert.after,
  skip.col.1 = TRUE,
  add.space = FALSE,
  multicol = NULL
)

Arguments

star	the stargazer output
insert.after	insert the column numbers after inster.after
skip.col.1	skip the first column? If TRUE no column number will be placed after the first column
add.space	add space before the previous column? Defaults to FALSE
multicol	if not NULL, multicolumn labels will be used. Options are "l" for left, "c" for center, and "r" for right. A character vector can be used for different alignments across different columns. If a single character is used, that alignment will be used for all elements in pattern. If a latex multicol is already applied by stargazer, multicol will be ignored for that variable.

Value

an updated version of the stargazer table with column numbers

Examples

library(stargazer)
data(mtcars)
star.out <- stargazer(as.matrix(head(mtcars)))
print(star.out)
##Insert column number using default values
star_add_column_numbers(star.out, insert.after = 10)
##Do not skip the first column when creating column numbers
star_add_column_numbers(star.out, insert.after = 10, skip.col.1 = FALSE)
##Add a space before the previous column
star_add_column_numbers(star.out, insert.after = 10, add.space = TRUE)
##Use multicolumns in latex. Could also pass a vector of columns
star_add_column_numbers(star.out, insert.after = 10, multicol = "c")
##Use multicolumn and don't skip the first column
star_add_column_numbers(star.out, insert.after = 10, skip.col.1 = FALSE, multicol = "c")

ChandlerLutz/starpolishr documentation built on Feb. 19, 2025, 2:22 a.m.