Skip to content

Commit a147fe7

Browse files
update documentation for latex and tab_options, link out for the rest of the help files to latex
1 parent d945bda commit a147fe7

24 files changed

+65
-4
lines changed

R/helpers.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ html <- function(text, ...) {
167167
#' exibble |>
168168
#' dplyr::select(currency, char) |>
169169
#' gt() |>
170-
#' tab_header(title = latex("\\emph{HTML}"))
170+
#' tab_header(title = latex("\\emph{LaTeX}"))
171171
#' ```
172172
#'
173173
#' \if{html}{\out{
@@ -182,7 +182,7 @@ html <- function(text, ...) {
182182
#' `v1.0.1` (May 10, 2025)
183183
#'
184184
#' @export
185-
latex <- function(text, ...) {
185+
latex <- function(text) {
186186

187187
# Apply the `from_latex` class
188188
class(text) <- "from_latex"

R/tab_options.R

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,26 @@
534534
#' use the `longtable` environment which will not float and may span multiple
535535
#' pages.
536536
#'
537+
#'
538+
#' @param latex.header_repeat
539+
#'
540+
#' * Specify if the header should repeat or not across pages*
541+
#'
542+
#' For Long tables, it may be desirable to have the column headers repeat on
543+
#' every page. Setting this parameter to `TRUE` will add a `\endhead` command
544+
#' after the table headers so LaTeX knows where the headers end and will
545+
#' repeat them on every page.
546+
#'
547+
#' @param latex.toprule,latex.bottomrule
548+
#'
549+
#' * Specify if an hrule should be put in the table at the top (latex.toprule) or bottom (latex.bottomrule)*
550+
#'
551+
#' By default the tables produced using latex code will include top and bottom
552+
#' lines in the table via `\toprule` and `\bottomrule`. Setting these
553+
#' parameters to `FALSE` will instead not have these commands added, which
554+
#' lets the tables be produced without the top and bottom lines.
555+
#'
556+
#'
537557
#' @param latex.tbl.pos
538558
#'
539559
#' *Specify latex floating position*

man/adjust_luminance.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cell_borders.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cell_fill.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cell_text.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/currency.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/default_fonts.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/escape_latex.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/from_column.Rd

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)