From 2ea0373915a514a8f724790e4bc5a10aa65291c1 Mon Sep 17 00:00:00 2001 From: Joe Zhu Date: Fri, 21 Jun 2024 00:04:17 +0800 Subject: [PATCH] update deps, [skip vbump] (#884) Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> --- DESCRIPTION | 4 ++-- NEWS.md | 4 ++-- R/argument_conventions.R | 10 +++++----- R/colby_constructors.R | 5 +++-- R/tree_accessors.R | 3 --- R/tt_compatibility.R | 4 ++-- R/tt_export.R | 12 ++++++------ R/tt_sort.R | 16 ++++++++-------- man/basic_table.Rd | 15 ++++++++------- man/constr_args.Rd | 10 +++++----- man/data.frame_export.Rd | 2 +- man/export_as_docx.Rd | 6 +++--- man/qtable_layout.Rd | 10 +++++----- man/rbind.Rd | 4 ++-- man/sort_at_path.Rd | 16 ++++++++-------- man/tabclasses.Rd | 10 +++++----- man/tt_to_flextable.Rd | 10 +++++----- 17 files changed, 70 insertions(+), 71 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index caf54b605..69817576d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: rtables Title: Reporting Tables -Version: 0.6.7.9007 +Version: 0.6.8 Date: 2024-06-16 Authors@R: c( person("Gabriel", "Becker", , "gabembecker@gmail.com", role = "aut", @@ -29,7 +29,7 @@ URL: https://github.com/insightsengineering/rtables, https://insightsengineering.github.io/rtables/ BugReports: https://github.com/insightsengineering/rtables/issues Depends: - formatters (>= 0.5.7.9001), + formatters (>= 0.5.8), magrittr (>= 1.5), methods, R (>= 2.10) diff --git a/NEWS.md b/NEWS.md index ad0a5fab6..e8a8859eb 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ -## rtables 0.6.7.9007 +## rtables 0.6.8 ### New Features - * Add support for truetype fonts based on `formatters` version `>= 0.5.6.9007`. Nearly all functions related to pagination or export now accept `fontspec` argument and pass it around accordingly, by @gmbecker. + * Add support for `truetype` fonts based on `formatters` version `>= 0.5.8`. Nearly all functions related to pagination or export now accept `fontspec` argument and pass it around accordingly, by @gmbecker. * Core splitting machinery can now be overridden in column space via `make_split_fun` provided that `core_split` associates the generated facets with subsetting expressions. Subsetting expressions remain unnecessary for splits in row space. By @gmbecker. * ValueWrapper objects now carry around subsetting expressions for use during tabulation, by @gmbecker. * `make_split_res`, `add_to_split_result` now accept a list of subsetting expressions which will be attached to the values, by @gmbecker. diff --git a/R/argument_conventions.R b/R/argument_conventions.R index 3c4a99641..04153b441 100644 --- a/R/argument_conventions.R +++ b/R/argument_conventions.R @@ -170,13 +170,13 @@ lyt_args <- function(lyt, var, vars, label, labels_var, varlabels, varnames, spl #' if not specified. #' @param lev (`integer(1)`)\cr nesting level (roughly, indentation level in practical terms). #' @param main_footer (`character`)\cr a vector of strings to use as main global (non-referential) footer materials -#' ([main_footer()]), where every element is printed on a separate line. +#' ([formatters::main_footer()]), where every element is printed on a separate line. #' @param page_title (`character`)\cr page-specific title(s). #' @param prov_footer (`character`)\cr a vector of strings to use as provenance-related global footer materials -#' ([prov_footer()]), where every element is printed on a separate line. -#' @param subtitles (`character`)\cr a vector of strings to use as subtitles ([subtitles()]), where every element is -#' printed on a separate line. Ignored for subtables. -#' @param title (`string`)\cr single string to use as main title ([main_title()]). Ignored for subtables. +#' ([formatters::prov_footer()]), where every element is printed on a separate line. +#' @param subtitles (`character`)\cr a vector of strings to use as subtitles ([formatters::subtitles()]), where every +#' element is printed on a separate line. Ignored for subtables. +#' @param title (`string`)\cr single string to use as main title ([formatters::main_title()]). Ignored for subtables. #' @param trailing_section_div (`string`)\cr string which will be used as a section divider after the printing #' of the last row contained in this (sub)table, unless that row is also the last table row to be printed overall, #' or `NA_character_` for none (the default). When generated via layouting, this would correspond to the diff --git a/R/colby_constructors.R b/R/colby_constructors.R index 19bd7dd47..b68836c5d 100644 --- a/R/colby_constructors.R +++ b/R/colby_constructors.R @@ -2025,8 +2025,9 @@ list_wrap_df <- function(f) { #' strange results, such as that individual arm columns and a combined "all patients" column all list "100%" as #' their percentage, even though the individual arm columns represent strict subsets of the "all patients" column. #' -#' - Note that subtitles ([subtitles()]) and footers ([main_footer()] and [prov_footer()]) that span more than one -#' line can be supplied as a character vector to maintain indentation on multiple lines. +#' - Note that subtitles ([formatters::subtitles()]) and footers ([formatters::main_footer()] and +#' [formatters::prov_footer()]) that span more than one line can be supplied as a character vector to maintain +#' indentation on multiple lines. #' #' @examples #' lyt <- basic_table() %>% diff --git a/R/tree_accessors.R b/R/tree_accessors.R index 6d8844a6b..48c75671c 100644 --- a/R/tree_accessors.R +++ b/R/tree_accessors.R @@ -1,6 +1,3 @@ -## XXX Do we want add.labrows here or no? -## we have to choose one and stick to it. - #' Internal generics and methods #' #' These are internal methods that are documented only to satisfy `R CMD check`. End users should pay no diff --git a/R/tt_compatibility.R b/R/tt_compatibility.R index da9998ec6..ec2b3d137 100644 --- a/R/tt_compatibility.R +++ b/R/tt_compatibility.R @@ -479,8 +479,8 @@ rbindl_rtables <- function(x, gap = lifecycle::deprecated(), check_headers = lif #' @note #' When objects are row-bound, titles and footer information is retained from the first object (if any exists) if all #' other objects have no titles/footers or have identical titles/footers. Otherwise, all titles/footers are removed -#' and must be set for the bound table via the [main_title()], [subtitles()], [main_footer()], and [prov_footer()] -#' functions. +#' and must be set for the bound table via the [formatters::main_title()], [formatters::subtitles()], +#' [formatters::main_footer()], and [formatters::prov_footer()] functions. #' #' @examples #' mtbl <- rtable( diff --git a/R/tt_export.R b/R/tt_export.R index 354d36080..7be70975f 100644 --- a/R/tt_export.R +++ b/R/tt_export.R @@ -103,7 +103,7 @@ formatters::export_as_txt #' @return #' * `as_result_df` returns a result `data.frame`. #' -#' @seealso [df_to_tt()] when using `as_is = TRUE` and [make_row_df()] to have a comprehensive view of the +#' @seealso [df_to_tt()] when using `as_is = TRUE` and [formatters::make_row_df()] to have a comprehensive view of the #' hierarchical structure of the rows. #' #' @examples @@ -741,12 +741,12 @@ margins_landscape <- function() { #' object to change its layout and style. If `NULL`, it will produce a table similar to `rtables` default. Defaults #' to `theme_docx_default(tt)`. #' @param border (`officer` border object)\cr defaults to `officer::fp_border(width = 0.5)`. -#' @param indent_size (`integer(1)`)\cr if `NULL`, the default indent size of the table (see [matrix_form()] +#' @param indent_size (`integer(1)`)\cr if `NULL`, the default indent size of the table (see [formatters::matrix_form()] #' `indent_size`) is used. To work with `docx`, any size is multiplied by 2 mm (5.67 pt) by default. #' @param titles_as_header (`flag`)\cr defaults to `TRUE` for [tt_to_flextable()], so the table is self-contained -#' as it makes additional header rows for [main_title()] string and [subtitles()] character vector (one per element). -#' `FALSE` is suggested for [export_as_docx()]. This adds titles and subtitles as a text paragraph above the table. -#' The same style is applied. +#' as it makes additional header rows for [formatters::main_title()] string and [formatters::subtitles()] character +#' vector (one per element). `FALSE` is suggested for [export_as_docx()]. This adds titles and subtitles as a text +#' paragraph above the table. The same style is applied. #' @param footers_as_text (`flag`)\cr defaults to `FALSE` for [tt_to_flextable()], so the table is self-contained with #' the `flextable` definition of footnotes. `TRUE` is used for [export_as_docx()] to add the footers as a new #' paragraph after the table. The same style is applied, but with a smaller font. @@ -974,7 +974,7 @@ tt_to_flextable <- function(tt, #' @param font_size (`integer(1)`)\cr font size. Defaults to 9. #' @param bold (`character`)\cr parts of the table text that should be in bold. Can be any combination of #' `c("header", "content_rows", "label_rows")`. The first one renders all column names bold (not `topleft` content). -#' The second and third option use [rtables::make_row_df()] to render content or/and label rows as bold. +#' The second and third option use [formatters::make_row_df()] to render content or/and label rows as bold. #' @param bold_manual (named `list` or `NULL`)\cr list of index lists. See example for needed structure. Accepted #' groupings/names are `c("header", "body")`. #' diff --git a/R/tt_sort.R b/R/tt_sort.R index cf8607490..74fbf44d6 100644 --- a/R/tt_sort.R +++ b/R/tt_sort.R @@ -75,9 +75,9 @@ cont_n_onecol <- function(j) { #' that each child at that step will be *separately* sorted based on `scorefun` and the remaining `path` entries. This #' can occur multiple times in a path. #' -#' A list of valid (non-wildcard) paths can be seen in the `path` column of the `data.frame` created by [make_row_df()] -#' with the `visible_only` argument set to `FALSE`. It can also be inferred from the summary given by -#' [table_structure()]. +#' A list of valid (non-wildcard) paths can be seen in the `path` column of the `data.frame` created by +#' [formatters::make_row_df()] with the `visible_only` argument set to `FALSE`. It can also be inferred from the +#' summary given by [table_structure()]. #' #' Note that sorting needs a deeper understanding of table structure in `rtables`. Please consider reading the related #' vignette @@ -91,17 +91,17 @@ cont_n_onecol <- function(j) { #' (coming from [summarize_row_groups()]) while a custom score function needs to be used on `DataRow`s. Here, some #' useful descriptor and accessor functions (coming from related vignette): #' - [cell_values()] - Retrieves a named list of a `TableRow` or `TableTree` object's values. -#' - [obj_name()] - Retrieves the name of an object. Note this can differ from the label that is displayed (if any is) -#' when printing. -#' - [obj_label()] - Retrieves the display label of an object. Note this can differ from the name that appears in the -#' path. +#' - [formatters::obj_name()] - Retrieves the name of an object. Note this can differ from the label that is +#' displayed (if any is) when printing. +#' - [formatters::obj_label()] - Retrieves the display label of an object. Note this can differ from the name that +#' appears in the path. #' - [content_table()] - Retrieves a `TableTree` object's content table (which contains its summary rows). #' - [tree_children()] - Retrieves a `TableTree` object's direct children (either subtables, rows or possibly a mix #' thereof, though that should not happen in practice). #' #' @seealso #' * Score functions [cont_n_allcols()] and [cont_n_onecol()]. -#' * [make_row_df()] and [table_structure()] for pathing information. +#' * [formatters::make_row_df()] and [table_structure()] for pathing information. #' * [tt_at_path()] to select a table's (sub)structure at a given path. #' #' @examples diff --git a/man/basic_table.Rd b/man/basic_table.Rd index eab53623b..db096524f 100644 --- a/man/basic_table.Rd +++ b/man/basic_table.Rd @@ -17,16 +17,16 @@ basic_table( ) } \arguments{ -\item{title}{(\code{string})\cr single string to use as main title (\code{\link[=main_title]{main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} -\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[=subtitles]{subtitles()}}), where every element is -printed on a separate line. Ignored for subtables.} +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:title_footer]{formatters::subtitles()}}), where every +element is printed on a separate line. Ignored for subtables.} \item{main_footer}{(\code{character})\cr a vector of strings to use as main global (non-referential) footer materials -(\code{\link[=main_footer]{main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} \item{prov_footer}{(\code{character})\cr a vector of strings to use as provenance-related global footer materials -(\code{\link[=prov_footer]{prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} \item{show_colcounts}{(\code{logical(1)})\cr Indicates whether the lowest level of applied to data. \code{NA}, the default, indicates that the \code{show_colcounts} @@ -69,8 +69,9 @@ of valid format labels to select from. \item Because percent components in \code{colcount_format} are \emph{always} populated with the value 1, we can get arguably strange results, such as that individual arm columns and a combined "all patients" column all list "100\%" as their percentage, even though the individual arm columns represent strict subsets of the "all patients" column. -\item Note that subtitles (\code{\link[=subtitles]{subtitles()}}) and footers (\code{\link[=main_footer]{main_footer()}} and \code{\link[=prov_footer]{prov_footer()}}) that span more than one -line can be supplied as a character vector to maintain indentation on multiple lines. +\item Note that subtitles (\code{\link[formatters:title_footer]{formatters::subtitles()}}) and footers (\code{\link[formatters:title_footer]{formatters::main_footer()}} and +\code{\link[formatters:title_footer]{formatters::prov_footer()}}) that span more than one line can be supplied as a character vector to maintain +indentation on multiple lines. } } \examples{ diff --git a/man/constr_args.Rd b/man/constr_args.Rd index ab2eb7d40..2211a8f66 100644 --- a/man/constr_args.Rd +++ b/man/constr_args.Rd @@ -71,16 +71,16 @@ summaries.} \item{child_names}{(\code{character})\cr names to be given to the subsplits contained by a compound split (typically an \code{AnalyzeMultiVars} split object).} -\item{title}{(\code{string})\cr single string to use as main title (\code{\link[=main_title]{main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} -\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[=subtitles]{subtitles()}}), where every element is -printed on a separate line. Ignored for subtables.} +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:title_footer]{formatters::subtitles()}}), where every +element is printed on a separate line. Ignored for subtables.} \item{main_footer}{(\code{character})\cr a vector of strings to use as main global (non-referential) footer materials -(\code{\link[=main_footer]{main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} \item{prov_footer}{(\code{character})\cr a vector of strings to use as provenance-related global footer materials -(\code{\link[=prov_footer]{prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} \item{footnotes}{(\code{list} or \code{NULL})\cr referential footnotes to be applied at current level. In post-processing, this can be achieved with \code{\link{fnotes_at_path<-}}.} diff --git a/man/data.frame_export.Rd b/man/data.frame_export.Rd index 6800fda86..ff8b3c529 100644 --- a/man/data.frame_export.Rd +++ b/man/data.frame_export.Rd @@ -94,6 +94,6 @@ path_enriched_df(tbl) } \seealso{ -\code{\link[=df_to_tt]{df_to_tt()}} when using \code{as_is = TRUE} and \code{\link[=make_row_df]{make_row_df()}} to have a comprehensive view of the +\code{\link[=df_to_tt]{df_to_tt()}} when using \code{as_is = TRUE} and \code{\link[formatters:make_row_df]{formatters::make_row_df()}} to have a comprehensive view of the hierarchical structure of the rows. } diff --git a/man/export_as_docx.Rd b/man/export_as_docx.Rd index b58b95853..3fc9e647c 100644 --- a/man/export_as_docx.Rd +++ b/man/export_as_docx.Rd @@ -36,9 +36,9 @@ margins_landscape() while \code{created} is a date object.} \item{titles_as_header}{(\code{flag})\cr defaults to \code{TRUE} for \code{\link[=tt_to_flextable]{tt_to_flextable()}}, so the table is self-contained -as it makes additional header rows for \code{\link[=main_title]{main_title()}} string and \code{\link[=subtitles]{subtitles()}} character vector (one per element). -\code{FALSE} is suggested for \code{\link[=export_as_docx]{export_as_docx()}}. This adds titles and subtitles as a text paragraph above the table. -The same style is applied.} +as it makes additional header rows for \code{\link[formatters:title_footer]{formatters::main_title()}} string and \code{\link[formatters:title_footer]{formatters::subtitles()}} character +vector (one per element). \code{FALSE} is suggested for \code{\link[=export_as_docx]{export_as_docx()}}. This adds titles and subtitles as a text +paragraph above the table. The same style is applied.} \item{footers_as_text}{(\code{flag})\cr defaults to \code{FALSE} for \code{\link[=tt_to_flextable]{tt_to_flextable()}}, so the table is self-contained with the \code{flextable} definition of footnotes. \code{TRUE} is used for \code{\link[=export_as_docx]{export_as_docx()}} to add the footers as a new diff --git a/man/qtable_layout.Rd b/man/qtable_layout.Rd index 218d69e80..74441927e 100644 --- a/man/qtable_layout.Rd +++ b/man/qtable_layout.Rd @@ -59,16 +59,16 @@ lists are interpreted as multiple cells.} \item{summarize_groups}{(\code{flag})\cr whether each level of nesting should include marginal summary rows. Defaults to \code{FALSE}.} -\item{title}{(\code{string})\cr single string to use as main title (\code{\link[=main_title]{main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} -\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[=subtitles]{subtitles()}}), where every element is -printed on a separate line. Ignored for subtables.} +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:title_footer]{formatters::subtitles()}}), where every +element is printed on a separate line. Ignored for subtables.} \item{main_footer}{(\code{character})\cr a vector of strings to use as main global (non-referential) footer materials -(\code{\link[=main_footer]{main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} \item{prov_footer}{(\code{character})\cr a vector of strings to use as provenance-related global footer materials -(\code{\link[=prov_footer]{prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} \item{show_colcounts}{(\code{logical(1)})\cr Indicates whether the lowest level of applied to data. \code{NA}, the default, indicates that the \code{show_colcounts} diff --git a/man/rbind.Rd b/man/rbind.Rd index b8c5dcde1..ee4e4b954 100644 --- a/man/rbind.Rd +++ b/man/rbind.Rd @@ -39,8 +39,8 @@ Row-bind \code{TableTree} and related objects \note{ When objects are row-bound, titles and footer information is retained from the first object (if any exists) if all other objects have no titles/footers or have identical titles/footers. Otherwise, all titles/footers are removed -and must be set for the bound table via the \code{\link[=main_title]{main_title()}}, \code{\link[=subtitles]{subtitles()}}, \code{\link[=main_footer]{main_footer()}}, and \code{\link[=prov_footer]{prov_footer()}} -functions. +and must be set for the bound table via the \code{\link[formatters:title_footer]{formatters::main_title()}}, \code{\link[formatters:title_footer]{formatters::subtitles()}}, +\code{\link[formatters:title_footer]{formatters::main_footer()}}, and \code{\link[formatters:title_footer]{formatters::prov_footer()}} functions. } \examples{ mtbl <- rtable( diff --git a/man/sort_at_path.Rd b/man/sort_at_path.Rd index d3190657c..e8c9bd96b 100644 --- a/man/sort_at_path.Rd +++ b/man/sort_at_path.Rd @@ -55,9 +55,9 @@ it, which we encourage users to avoid. that each child at that step will be \emph{separately} sorted based on \code{scorefun} and the remaining \code{path} entries. This can occur multiple times in a path. -A list of valid (non-wildcard) paths can be seen in the \code{path} column of the \code{data.frame} created by \code{\link[=make_row_df]{make_row_df()}} -with the \code{visible_only} argument set to \code{FALSE}. It can also be inferred from the summary given by -\code{\link[=table_structure]{table_structure()}}. +A list of valid (non-wildcard) paths can be seen in the \code{path} column of the \code{data.frame} created by +\code{\link[formatters:make_row_df]{formatters::make_row_df()}} with the \code{visible_only} argument set to \code{FALSE}. It can also be inferred from the +summary given by \code{\link[=table_structure]{table_structure()}}. Note that sorting needs a deeper understanding of table structure in \code{rtables}. Please consider reading the related vignette @@ -72,10 +72,10 @@ Built-in score functions are \code{\link[=cont_n_allcols]{cont_n_allcols()}} and useful descriptor and accessor functions (coming from related vignette): \itemize{ \item \code{\link[=cell_values]{cell_values()}} - Retrieves a named list of a \code{TableRow} or \code{TableTree} object's values. -\item \code{\link[=obj_name]{obj_name()}} - Retrieves the name of an object. Note this can differ from the label that is displayed (if any is) -when printing. -\item \code{\link[=obj_label]{obj_label()}} - Retrieves the display label of an object. Note this can differ from the name that appears in the -path. +\item \code{\link[formatters:lab_name]{formatters::obj_name()}} - Retrieves the name of an object. Note this can differ from the label that is +displayed (if any is) when printing. +\item \code{\link[formatters:lab_name]{formatters::obj_label()}} - Retrieves the display label of an object. Note this can differ from the name that +appears in the path. \item \code{\link[=content_table]{content_table()}} - Retrieves a \code{TableTree} object's content table (which contains its summary rows). \item \code{\link[=tree_children]{tree_children()}} - Retrieves a \code{TableTree} object's direct children (either subtables, rows or possibly a mix thereof, though that should not happen in practice). @@ -129,7 +129,7 @@ sort_at_path(tbl, c("RACE", "*", "STRATA1", "*", "AGE"), scorefun) \seealso{ \itemize{ \item Score functions \code{\link[=cont_n_allcols]{cont_n_allcols()}} and \code{\link[=cont_n_onecol]{cont_n_onecol()}}. -\item \code{\link[=make_row_df]{make_row_df()}} and \code{\link[=table_structure]{table_structure()}} for pathing information. +\item \code{\link[formatters:make_row_df]{formatters::make_row_df()}} and \code{\link[=table_structure]{table_structure()}} for pathing information. \item \code{\link[=tt_at_path]{tt_at_path()}} to select a table's (sub)structure at a given path. } } diff --git a/man/tabclasses.Rd b/man/tabclasses.Rd index 7ec9e1764..d1c4acc91 100644 --- a/man/tabclasses.Rd +++ b/man/tabclasses.Rd @@ -90,16 +90,16 @@ functions. See \code{\link[formatters:list_formats]{formatters::list_valid_forma function (subtable, content table, or row) \emph{and all of that structure's children}. Defaults to 0, which corresponds to the unmodified default behavior.} -\item{title}{(\code{string})\cr single string to use as main title (\code{\link[=main_title]{main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} -\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[=subtitles]{subtitles()}}), where every element is -printed on a separate line. Ignored for subtables.} +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:title_footer]{formatters::subtitles()}}), where every +element is printed on a separate line. Ignored for subtables.} \item{main_footer}{(\code{character})\cr a vector of strings to use as main global (non-referential) footer materials -(\code{\link[=main_footer]{main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} \item{prov_footer}{(\code{character})\cr a vector of strings to use as provenance-related global footer materials -(\code{\link[=prov_footer]{prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} \item{header_section_div}{(\code{string})\cr string which will be used to divide the header from the table. See \code{\link[=header_section_div]{header_section_div()}} for the associated getter and setter. Please consider changing last element of diff --git a/man/tt_to_flextable.Rd b/man/tt_to_flextable.Rd index 075e9355e..b25ded338 100644 --- a/man/tt_to_flextable.Rd +++ b/man/tt_to_flextable.Rd @@ -41,13 +41,13 @@ to \code{theme_docx_default(tt)}.} \item{border}{(\code{officer} border object)\cr defaults to \code{officer::fp_border(width = 0.5)}.} -\item{indent_size}{(\code{integer(1)})\cr if \code{NULL}, the default indent size of the table (see \code{\link[=matrix_form]{matrix_form()}} +\item{indent_size}{(\code{integer(1)})\cr if \code{NULL}, the default indent size of the table (see \code{\link[formatters:matrix_form]{formatters::matrix_form()}} \code{indent_size}) is used. To work with \code{docx}, any size is multiplied by 2 mm (5.67 pt) by default.} \item{titles_as_header}{(\code{flag})\cr defaults to \code{TRUE} for \code{\link[=tt_to_flextable]{tt_to_flextable()}}, so the table is self-contained -as it makes additional header rows for \code{\link[=main_title]{main_title()}} string and \code{\link[=subtitles]{subtitles()}} character vector (one per element). -\code{FALSE} is suggested for \code{\link[=export_as_docx]{export_as_docx()}}. This adds titles and subtitles as a text paragraph above the table. -The same style is applied.} +as it makes additional header rows for \code{\link[formatters:title_footer]{formatters::main_title()}} string and \code{\link[formatters:title_footer]{formatters::subtitles()}} character +vector (one per element). \code{FALSE} is suggested for \code{\link[=export_as_docx]{export_as_docx()}}. This adds titles and subtitles as a text +paragraph above the table. The same style is applied.} \item{footers_as_text}{(\code{flag})\cr defaults to \code{FALSE} for \code{\link[=tt_to_flextable]{tt_to_flextable()}}, so the table is self-contained with the \code{flextable} definition of footnotes. \code{TRUE} is used for \code{\link[=export_as_docx]{export_as_docx()}} to add the footers as a new @@ -86,7 +86,7 @@ used. Parameter is ignored if \code{tf_wrap = FALSE}.} \item{bold}{(\code{character})\cr parts of the table text that should be in bold. Can be any combination of \code{c("header", "content_rows", "label_rows")}. The first one renders all column names bold (not \code{topleft} content). -The second and third option use \code{\link[=make_row_df]{make_row_df()}} to render content or/and label rows as bold.} +The second and third option use \code{\link[formatters:make_row_df]{formatters::make_row_df()}} to render content or/and label rows as bold.} \item{bold_manual}{(named \code{list} or \code{NULL})\cr list of index lists. See example for needed structure. Accepted groupings/names are \code{c("header", "body")}.}