docs

R/group_tt.R

@@ -3,8 +3,20 @@
 #' @export
 #' @inheritParams tt
 #' @inheritParams style_tt
+#' @param i A named list of row indices to group. The names of the list will be used as labels.
+#' @param j A named list of column indices to group. The names of the list will be used as labels. See examples below..
 #' @return An object of class `tt` representing the table.
 #' @param indent integer number of `pt` to use when indenting the non-labelled rows.
+#' @examples 
+#' 
+#' tt(mtcars[1:10, 1:5]) |>
+#'   group_tt(
+#'     i = list(
+#'       "Hello" = 3,
+#'       "World" = 8),
+#'     j = list(
+#'       "Foo" = 2:3,
+#'       "Bar" = 4:5))
 group_tt <- function(x, i = NULL, j = NULL, indent = 1) {
 
   if (is.null(meta(x))) stop("`x` must be generated by `tinytable::tt()`.", call. = FALSE)

R/style_tt.R

@@ -1,9 +1,9 @@
-#' Style a Tiny Table in either LaTeX or HTML format
+#' Style a Tiny Table
 #'
 #' @details
-#' This function applies styling to a table created by `tt()`. It allows customization of text style (bold, italic, monospace), text and background colors, font size, cell width, text alignment, column span, and indentation. The function supports both LaTeX (tabularray) and HTML (bootstrap) formats.
+#' This function applies styling to a table created by `tt()`. It allows customization of text style (bold, italic, monospace), text and background colors, font size, cell width, text alignment, column span, and indentation. The function also supports passing native instructions to LaTeX (tabularray) and HTML (bootstrap) formats.
 #'
-#' Note that Markdown and Word formats are limited to these styles: italic, bold, strikeout.
+#' Warning: Markdown and Word formats are limited to these styles: italic, bold, strikeout. This is because there is no markdown syntax for the other options, and because we create Word documents by converting a markdown table to .docx via the Pandoc software.
 #'
 #' @param x A table object created by `tt()`.
 #' @param i Row indices where the styling should be applied. Can be a single value or a vector. `i=0` is the header, and negative values are higher level headers. If `colspan` is used, `i` must be of length 1.