Skip to content

Commit

Permalink
doc: dependencies section
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentarelbundock committed Dec 2, 2024
1 parent 3c3f2ce commit 74d47ab
Show file tree
Hide file tree
Showing 5 changed files with 113 additions and 0 deletions.
3 changes: 3 additions & 0 deletions R/save_tt.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
#' the images are included in the HTML as base64 encoded string instead of link to a local file.
#' @param overwrite A logical value indicating whether to overwrite an existing file.
#' @return A string with the table when `output` is a format, and the file path when `output` is a valid path.
#' @template dependencies
#' @template latex_preamble
#' @template global_options
#' @export
#' @examples
#' library(tinytable)
Expand Down
1 change: 1 addition & 0 deletions R/tt.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
#' @return An object of class `tt` representing the table.
#'
#' The table object has S4 slots which hold information about the structure of the table. Relying on or modifying the contents of these slots is strongly discouraged. Their names and contents could change at any time, and the `tinytable` developers do not consider changes to the internal structure of the output object to be a "breaking change" for versioning or changelog purposes.
#' @template dependencies
#' @template latex_preamble
#' @template global_options
#'
Expand Down
5 changes: 5 additions & 0 deletions man-roxygen/dependencies.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#' @section Dependencies:
#'
#' * `.pdf` output requires a full LaTeX installation on the local computer.
#' * `.png` output requires the `webshot2` package.
#' * `.html` self-contained files require the `base64enc` package.
95 changes: 95 additions & 0 deletions man/save_tt.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions man/tt.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 74d47ab

Please sign in to comment.