From 41a50f9e2e617d95b7143778af7158499f651491 Mon Sep 17 00:00:00 2001 From: Joe Zhu Date: Mon, 27 Apr 2026 10:16:05 +0800 Subject: [PATCH 1/2] Update CODEOWNERS to change ownership assignments Signed-off-by: Joe Zhu --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 41f979cbbe..c2eb93da32 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @edelarua @Melkiades @ayogasekaram +* @Melkiades @shajoezhu From ede645e7961357f9dc8eadd89884468f856addff Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 21 May 2026 02:57:29 +0000 Subject: [PATCH 2/2] [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update --- DESCRIPTION | 2 +- man/CellValue.Rd | 4 ++-- man/add_colcounts.Rd | 2 +- man/add_combo_facet.Rd | 12 ++++++------ man/add_overall_level.Rd | 5 ----- man/analyze.Rd | 4 ++-- man/analyze_colvars.Rd | 2 +- man/as_html.Rd | 2 +- man/basic_table.Rd | 14 +++++++------- man/build_table.Rd | 2 +- man/compat_args.Rd | 12 ++++++------ man/constr_args.Rd | 18 +++++++++--------- man/drop_facet_levels.Rd | 12 ++++++------ man/find_degen_struct.Rd | 6 +++--- man/gen_args.Rd | 12 ++++++------ man/in_rows.Rd | 2 +- man/int_methods.Rd | 2 +- man/lyt_args.Rd | 14 +++++++------- man/make_split_fun.Rd | 12 ++++++------ man/make_split_result.Rd | 19 ++++++------------- man/qtable_layout.Rd | 8 ++++---- man/rbind.Rd | 4 ++-- man/rcell.Rd | 4 ++-- man/reexports.Rd | 2 +- man/restrict_facets.Rd | 12 ++++++------ man/rheader.Rd | 10 +++++----- man/rowclasses.Rd | 4 ++-- man/rrow.Rd | 12 ++++++------ man/rrowl.Rd | 12 ++++++------ man/rtable.Rd | 14 +++++++------- man/rtables-package.Rd | 3 +++ man/sanitize_table_struct.Rd | 6 +++--- man/sf_args.Rd | 10 +++++----- man/sort_at_path.Rd | 4 ++-- man/split_cols_by.Rd | 2 +- man/split_rows_by.Rd | 2 +- man/split_rows_by_multivar.Rd | 2 +- man/summarize_row_groups.Rd | 2 +- man/tabclasses.Rd | 12 ++++++------ man/trim_levels_in_facets.Rd | 12 ++++++------ man/validate_table_struct.Rd | 6 +++--- man/varcuts.Rd | 2 +- 42 files changed, 147 insertions(+), 156 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 597b56e212..f9a6c8be66 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -71,7 +71,6 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.3 Collate: '00tabletrees.R' 'Viewer.R' @@ -105,3 +104,4 @@ Collate: 'tt_from_df.R' 'validate_table_struct.R' 'zzz_constants.R' +Config/roxygen2/version: 8.0.0 diff --git a/man/CellValue.Rd b/man/CellValue.Rd index 5df5c31a31..56fb850be3 100644 --- a/man/CellValue.Rd +++ b/man/CellValue.Rd @@ -22,7 +22,7 @@ CellValue( \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{colspan}{(\code{integer(1)})\cr column span value.} @@ -35,7 +35,7 @@ corresponds to the unmodified default behavior.} \item{footnotes}{(\code{list} or \code{NULL})\cr referential footnote messages for the cell.} \item{align}{(\code{string} or \code{NULL})\cr alignment the value should be rendered with. Defaults to \code{"center"} if -\code{NULL} is used. See \code{\link[formatters:list_formats]{formatters::list_valid_aligns()}} for all currently supported alignments.} +\code{NULL} is used. See \code{\link[formatters:list_valid_aligns]{formatters::list_valid_aligns()}} for all currently supported alignments.} \item{format_na_str}{(\code{string})\cr string which should be displayed when formatted if this cell's value(s) are all \code{NA}.} diff --git a/man/add_colcounts.Rd b/man/add_colcounts.Rd index e6ae068f64..4238a9a123 100644 --- a/man/add_colcounts.Rd +++ b/man/add_colcounts.Rd @@ -11,7 +11,7 @@ add_colcounts(lyt, format = "(N=xx)") \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} } \value{ A \code{PreDataTableLayouts} object suitable for passing to further layouting functions, and to \code{\link[=build_table]{build_table()}}. diff --git a/man/add_combo_facet.Rd b/man/add_combo_facet.Rd index f4f8667209..9ac9e18488 100644 --- a/man/add_combo_facet.Rd +++ b/man/add_combo_facet.Rd @@ -48,11 +48,11 @@ tbl <- build_table(lyt, DM) \seealso{ \code{\link[=make_split_fun]{make_split_fun()}} -Other make_custom_split: -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_fun}()}, -\code{\link{make_split_result}()}, -\code{\link{restrict_facets}()}, -\code{\link{trim_levels_in_facets}()} +Other make_custom_split: +\code{\link[=drop_facet_levels]{drop_facet_levels()}}, +\code{\link[=make_split_fun]{make_split_fun()}}, +\code{\link[=make_split_result]{make_split_result()}}, +\code{\link[=restrict_facets]{restrict_facets()}}, +\code{\link[=trim_levels_in_facets]{trim_levels_in_facets()}} } \concept{make_custom_split} diff --git a/man/add_overall_level.Rd b/man/add_overall_level.Rd index 1c568e519c..a978e17be0 100644 --- a/man/add_overall_level.Rd +++ b/man/add_overall_level.Rd @@ -1,14 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/default_split_funs.R -\docType{data} \name{add_overall_level} \alias{add_overall_level} \alias{select_all_levels} \alias{add_combo_levels} \title{Add overall or combination levels to split groups} -\format{ -An object of class \code{AllLevelsSentinel} of length 0. -} \usage{ add_overall_level( valname = "Overall", @@ -132,4 +128,3 @@ tbl3 \seealso{ \link{custom_split_funs} and \link{split_funcs}. } -\keyword{datasets} diff --git a/man/analyze.Rd b/man/analyze.Rd index b03755d533..269e8207d7 100644 --- a/man/analyze.Rd +++ b/man/analyze.Rd @@ -42,7 +42,7 @@ analyzing a single variable.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{formats_var}{(\code{string} or \code{NULL})\cr \code{NULL} (the default) or the name of the list column containing named lists of default formats to use. These will be applied with the same precedence as the \code{format} argument; i.e., @@ -117,7 +117,7 @@ calculated during the tabulation process, but will be overridden by formats specified within \code{rcell} calls in \code{afun}. \code{format} can accept a format label string (see -\code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}}), a formatting function, an +\code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}}), a formatting function, an unnamed list, or a named list. When \code{format} is an unnamed list - or a named list where not all diff --git a/man/analyze_colvars.Rd b/man/analyze_colvars.Rd index af9a73de94..6726f7578d 100644 --- a/man/analyze_colvars.Rd +++ b/man/analyze_colvars.Rd @@ -31,7 +31,7 @@ analyzing a single variable.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/as_html.Rd b/man/as_html.Rd index 464ee54625..22b25bf8a3 100644 --- a/man/as_html.Rd +++ b/man/as_html.Rd @@ -46,7 +46,7 @@ to \code{FALSE}.} Doing this keeps the structure of the cells but may depend on the output device.} \item{round_type}{(\code{"iec"}, \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. -See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} +See \code{\link[formatters:round_fmt]{round_fmt()}} for details.} } \value{ A \code{shiny.tag} object representing \code{x} in HTML. diff --git a/man/basic_table.Rd b/man/basic_table.Rd index 5eb8d665c0..0ba10649fe 100644 --- a/man/basic_table.Rd +++ b/man/basic_table.Rd @@ -18,16 +18,16 @@ basic_table( ) } \arguments{ -\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:main_title]{formatters::main_title()}}). 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 +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:subtitles]{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[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:main_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[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:prov_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} @@ -65,7 +65,7 @@ Every layout must start with a basic table. and \code{colcount_format} is 2-dimensional with a percent component, the value component for the percent is always populated with \code{1} (i.e. 100\%). 1d formats are used to render the counts exactly as they normally would be, while 2d formats which don't include a percent, and all 3d formats result in an error. Formats in the form of -functions are not supported for \code{colcount} format. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for the list +functions are not supported for \code{colcount} format. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for the list of valid format labels to select from. } \note{ @@ -73,8 +73,8 @@ 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[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 +\item Note that subtitles (\code{\link[formatters:subtitles]{formatters::subtitles()}}) and footers (\code{\link[formatters:main_footer]{formatters::main_footer()}} and +\code{\link[formatters:prov_footer]{formatters::prov_footer()}}) that span more than one line can be supplied as a character vector to maintain indentation on multiple lines. } } diff --git a/man/build_table.Rd b/man/build_table.Rd index 061991e7e3..207dda9b24 100644 --- a/man/build_table.Rd +++ b/man/build_table.Rd @@ -36,7 +36,7 @@ calculated counts. Turns on display of leaf-column counts when non-\code{NULL}.} \item{hsep}{(\code{string})\cr set of characters to be repeated as the separator between the header and body of the table when rendered as text. Defaults to a connected horizontal line (unicode 2014) in locals that use a UTF -charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:default_horizontal_sep]{formatters::set_default_hsep()}} for further +charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:set_default_hsep]{formatters::set_default_hsep()}} for further information.} \item{round_type}{(\code{"iec"} (default), \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. diff --git a/man/compat_args.Rd b/man/compat_args.Rd index 04b3275624..53b9da8e81 100644 --- a/man/compat_args.Rd +++ b/man/compat_args.Rd @@ -14,7 +14,7 @@ Arguments passed via \code{...} will be ignored if this is specified.} \code{\link[=rrow]{rrow()}}.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr the format label (string) or formatter function to apply to the -cell values passed via \code{...}. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +cell values passed via \code{...}. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{indent}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}} @@ -30,10 +30,10 @@ No return value. Compatibility argument conventions } \seealso{ -Other conventions: -\code{\link{constr_args}()}, -\code{\link{gen_args}()}, -\code{\link{lyt_args}()}, -\code{\link{sf_args}()} +Other conventions: +\code{\link[=constr_args]{constr_args()}}, +\code{\link[=gen_args]{gen_args()}}, +\code{\link[=lyt_args]{lyt_args()}}, +\code{\link[=sf_args]{sf_args()}} } \concept{conventions} diff --git a/man/constr_args.Rd b/man/constr_args.Rd index 2211a8f66d..74cb46137f 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[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:main_title]{formatters::main_title()}}). 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 +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:subtitles]{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[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:main_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[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:prov_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<-}}.} @@ -119,11 +119,11 @@ No return value. Constructor argument conventions } \seealso{ -Other conventions: -\code{\link{compat_args}()}, -\code{\link{gen_args}()}, -\code{\link{lyt_args}()}, -\code{\link{sf_args}()} +Other conventions: +\code{\link[=compat_args]{compat_args()}}, +\code{\link[=gen_args]{gen_args()}}, +\code{\link[=lyt_args]{lyt_args()}}, +\code{\link[=sf_args]{sf_args()}} } \concept{conventions} \keyword{internal} diff --git a/man/drop_facet_levels.Rd b/man/drop_facet_levels.Rd index 1433646c82..ace0490536 100644 --- a/man/drop_facet_levels.Rd +++ b/man/drop_facet_levels.Rd @@ -20,11 +20,11 @@ directly by end users. \seealso{ \code{\link[=make_split_fun]{make_split_fun()}} -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{make_split_fun}()}, -\code{\link{make_split_result}()}, -\code{\link{restrict_facets}()}, -\code{\link{trim_levels_in_facets}()} +Other make_custom_split: +\code{\link[=add_combo_facet]{add_combo_facet()}}, +\code{\link[=make_split_fun]{make_split_fun()}}, +\code{\link[=make_split_result]{make_split_result()}}, +\code{\link[=restrict_facets]{restrict_facets()}}, +\code{\link[=trim_levels_in_facets]{trim_levels_in_facets()}} } \concept{make_custom_split} diff --git a/man/find_degen_struct.Rd b/man/find_degen_struct.Rd index bc10e03489..ff0225eb07 100644 --- a/man/find_degen_struct.Rd +++ b/man/find_degen_struct.Rd @@ -23,8 +23,8 @@ find_degen_struct(rtable("hi")) } \seealso{ -Other table structure validation functions: -\code{\link{sanitize_table_struct}()}, -\code{\link{validate_table_struct}()} +Other table structure validation functions: +\code{\link[=sanitize_table_struct]{sanitize_table_struct()}}, +\code{\link[=validate_table_struct]{validate_table_struct()}} } \concept{table structure validation functions} diff --git a/man/gen_args.Rd b/man/gen_args.Rd index 7f2b632872..e3b9669a53 100644 --- a/man/gen_args.Rd +++ b/man/gen_args.Rd @@ -80,7 +80,7 @@ the children of a split/table.} \item{hsep}{(\code{string})\cr set of characters to be repeated as the separator between the header and body of the table when rendered as text. Defaults to a connected horizontal line (unicode 2014) in locals that use a UTF -charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:default_horizontal_sep]{formatters::set_default_hsep()}} for further +charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:set_default_hsep]{formatters::set_default_hsep()}} for further information.} \item{indent_size}{(\code{numeric(1)})\cr number of spaces to use per indent level. Defaults to 2.} @@ -116,11 +116,11 @@ No return value. General argument conventions } \seealso{ -Other conventions: -\code{\link{compat_args}()}, -\code{\link{constr_args}()}, -\code{\link{lyt_args}()}, -\code{\link{sf_args}()} +Other conventions: +\code{\link[=compat_args]{compat_args()}}, +\code{\link[=constr_args]{constr_args()}}, +\code{\link[=lyt_args]{lyt_args()}}, +\code{\link[=sf_args]{sf_args()}} } \concept{conventions} \keyword{internal} diff --git a/man/in_rows.Rd b/man/in_rows.Rd index 665638cc25..4867a041a1 100644 --- a/man/in_rows.Rd +++ b/man/in_rows.Rd @@ -36,7 +36,7 @@ in_rows( \item{.row_footnotes}{(\code{list})\cr referential footnotes messages to be associated by name with \emph{rows}.} \item{.aligns}{(\code{character} or \code{NULL})\cr alignments for the cells. Standard for \code{NULL} is \code{"center"}. -See \code{\link[formatters:list_formats]{formatters::list_valid_aligns()}} for currently supported alignments.} +See \code{\link[formatters:list_valid_aligns]{formatters::list_valid_aligns()}} for currently supported alignments.} \item{.format_na_strs}{(\code{character} or \code{NULL})\cr NA strings for the cells.} diff --git a/man/int_methods.Rd b/man/int_methods.Rd index 9c528cc439..31bad1aec2 100644 --- a/man/int_methods.Rd +++ b/man/int_methods.Rd @@ -1270,7 +1270,7 @@ underneath analyses, which is not allowed.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/lyt_args.Rd b/man/lyt_args.Rd index 7a3d5009c8..ed05d03091 100644 --- a/man/lyt_args.Rd +++ b/man/lyt_args.Rd @@ -83,7 +83,7 @@ underneath analyses, which is not allowed.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{cfun}{(\code{list}, \code{function}, or \code{NULL})\cr tabulation function(s) for creating content rows. Must accept \code{x} or \code{df} as first parameter. Must accept \code{labelstr} as the second argument. Can optionally accept all optional @@ -162,7 +162,7 @@ analyzed at the same level of nesting.} \item{topleft}{(\code{character})\cr override values for the "top left" material to be displayed during printing.} \item{align}{(\code{string} or \code{NULL})\cr alignment the value should be rendered with. Defaults to \code{"center"} if -\code{NULL} is used. See \code{\link[formatters:list_formats]{formatters::list_valid_aligns()}} for all currently supported alignments.} +\code{NULL} is used. See \code{\link[formatters:list_valid_aligns]{formatters::list_valid_aligns()}} for all currently supported alignments.} \item{page_by}{(\code{flag})\cr whether pagination should be forced between different children resulting from this split. An error will occur if the selected split does not contain at least one value that is not \code{NA}.} @@ -207,11 +207,11 @@ No return value. Layouting function argument conventions } \seealso{ -Other conventions: -\code{\link{compat_args}()}, -\code{\link{constr_args}()}, -\code{\link{gen_args}()}, -\code{\link{sf_args}()} +Other conventions: +\code{\link[=compat_args]{compat_args()}}, +\code{\link[=constr_args]{constr_args()}}, +\code{\link[=gen_args]{gen_args()}}, +\code{\link[=sf_args]{sf_args()}} } \concept{conventions} \keyword{internal} diff --git a/man/make_split_fun.Rd b/man/make_split_fun.Rd index f66b7c04cb..2c62183979 100644 --- a/man/make_split_fun.Rd +++ b/man/make_split_fun.Rd @@ -124,11 +124,11 @@ silly_table \seealso{ \link{custom_split_funs} for a more detailed discussion on what custom split functions do. -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_result}()}, -\code{\link{restrict_facets}()}, -\code{\link{trim_levels_in_facets}()} +Other make_custom_split: +\code{\link[=add_combo_facet]{add_combo_facet()}}, +\code{\link[=drop_facet_levels]{drop_facet_levels()}}, +\code{\link[=make_split_result]{make_split_result()}}, +\code{\link[=restrict_facets]{restrict_facets()}}, +\code{\link[=trim_levels_in_facets]{trim_levels_in_facets()}} } \concept{make_custom_split} diff --git a/man/make_split_result.Rd b/man/make_split_result.Rd index a6056070ae..ea35124d1d 100644 --- a/man/make_split_result.Rd +++ b/man/make_split_result.Rd @@ -66,18 +66,11 @@ splres2 <- add_to_split_result(splres, } \seealso{ -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_fun}()}, -\code{\link{restrict_facets}()}, -\code{\link{trim_levels_in_facets}()} - -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_fun}()}, -\code{\link{restrict_facets}()}, -\code{\link{trim_levels_in_facets}()} +Other make_custom_split: +\code{\link[=add_combo_facet]{add_combo_facet()}}, +\code{\link[=drop_facet_levels]{drop_facet_levels()}}, +\code{\link[=make_split_fun]{make_split_fun()}}, +\code{\link[=restrict_facets]{restrict_facets()}}, +\code{\link[=trim_levels_in_facets]{trim_levels_in_facets()}} } \concept{make_custom_split} diff --git a/man/qtable_layout.Rd b/man/qtable_layout.Rd index 74441927e1..4c90212640 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[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:main_title]{formatters::main_title()}}). 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 +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:subtitles]{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[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:main_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[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:prov_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 ee4e4b9545..411049254f 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[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. +and must be set for the bound table via the \code{\link[formatters:main_title]{formatters::main_title()}}, \code{\link[formatters:subtitles]{formatters::subtitles()}}, +\code{\link[formatters:main_footer]{formatters::main_footer()}}, and \code{\link[formatters:prov_footer]{formatters::prov_footer()}} functions. } \examples{ mtbl <- rtable( diff --git a/man/rcell.Rd b/man/rcell.Rd index f1afb249aa..ba73f89d3b 100644 --- a/man/rcell.Rd +++ b/man/rcell.Rd @@ -34,7 +34,7 @@ non_ref_rcell( \item{x}{(\code{ANY})\cr cell value.} \item{format}{(\code{string} or \code{function})\cr the format label (string) or \code{formatters} function to apply to \code{x}. -See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{colspan}{(\code{integer(1)})\cr column span value.} @@ -47,7 +47,7 @@ corresponds to the unmodified default behavior.} \item{footnotes}{(\code{list} or \code{NULL})\cr referential footnote messages for the cell.} \item{align}{(\code{string} or \code{NULL})\cr alignment the value should be rendered with. Defaults to \code{"center"} if -\code{NULL} is used. See \code{\link[formatters:list_formats]{formatters::list_valid_aligns()}} for all currently supported alignments.} +\code{NULL} is used. See \code{\link[formatters:list_valid_aligns]{formatters::list_valid_aligns()}} for all currently supported alignments.} \item{format_na_str}{(\code{string})\cr string which should be displayed when formatted if this cell's value(s) are all \code{NA}.} diff --git a/man/reexports.Rd b/man/reexports.Rd index e9b22573e0..04c055889b 100644 --- a/man/reexports.Rd +++ b/man/reexports.Rd @@ -41,6 +41,6 @@ These objects are imported from other packages. Follow the links below to see their documentation. \describe{ - \item{formatters}{\code{\link[formatters]{export_as_pdf}}, \code{\link[formatters]{export_as_txt}}} + \item{formatters}{\code{\link[formatters:export_as_pdf]{export_as_pdf()}}, \code{\link[formatters:export_as_txt]{export_as_txt()}}} }} diff --git a/man/restrict_facets.Rd b/man/restrict_facets.Rd index 0e04387552..e30d844aad 100644 --- a/man/restrict_facets.Rd +++ b/man/restrict_facets.Rd @@ -74,11 +74,11 @@ build_table(lyt, ex_adsl) \seealso{ \code{\link[=make_split_fun]{make_split_fun()}} -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_fun}()}, -\code{\link{make_split_result}()}, -\code{\link{trim_levels_in_facets}()} +Other make_custom_split: +\code{\link[=add_combo_facet]{add_combo_facet()}}, +\code{\link[=drop_facet_levels]{drop_facet_levels()}}, +\code{\link[=make_split_fun]{make_split_fun()}}, +\code{\link[=make_split_result]{make_split_result()}}, +\code{\link[=trim_levels_in_facets]{trim_levels_in_facets()}} } \concept{make_custom_split} diff --git a/man/rheader.Rd b/man/rheader.Rd index 0aaf605362..67911967ed 100644 --- a/man/rheader.Rd +++ b/man/rheader.Rd @@ -11,7 +11,7 @@ rheader(..., format = "xx", .lst = NULL) \code{\link[=LabelRow]{LabelRow()}}, etc.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr the format label (string) or formatter function to apply to the -cell values passed via \code{...}. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +cell values passed via \code{...}. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{.lst}{(\code{list})\cr an already-collected list of arguments to be used instead of the elements of \code{...}. Arguments passed via \code{...} will be ignored if this is specified.} @@ -34,9 +34,9 @@ h2 } \seealso{ -Other compatibility: -\code{\link{rrow}()}, -\code{\link{rrowl}()}, -\code{\link{rtable}()} +Other compatibility: +\code{\link[=rrow]{rrow()}}, +\code{\link[=rrowl]{rrowl()}}, +\code{\link[=rtable]{rtable()}} } \concept{compatibility} diff --git a/man/rowclasses.Rd b/man/rowclasses.Rd index 0bb7a401cb..2798b27eeb 100644 --- a/man/rowclasses.Rd +++ b/man/rowclasses.Rd @@ -70,7 +70,7 @@ or \code{NA_character_} for none (the default). When generated via layouting, th \code{section_div} of the split under which this table represents a single facet.} \item{round_type}{(\code{"iec"}, \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. -See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} +See \code{\link[formatters:round_fmt]{round_fmt()}} for details.} \item{vals}{(\code{list})\cr cell values for the row.} @@ -80,7 +80,7 @@ See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/rrow.Rd b/man/rrow.Rd index f500bedb9d..3b5efdb357 100644 --- a/man/rrow.Rd +++ b/man/rrow.Rd @@ -20,7 +20,7 @@ rrow( \item{...}{cell values.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr the format label (string) or formatter function to apply to the -cell values passed via \code{...}. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +cell values passed via \code{...}. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{indent}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}} @@ -28,7 +28,7 @@ cell values passed via \code{...}. See \code{\link[formatters:list_formats]{form \code{\link[formatters:table_inset]{formatters::table_inset()}} for details.} \item{round_type}{(\code{"iec"}, \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. -See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} +See \code{\link[formatters:round_fmt]{round_fmt()}} for details.} } \value{ A row object of the context-appropriate type (label or data). @@ -42,9 +42,9 @@ rrow("") } \seealso{ -Other compatibility: -\code{\link{rheader}()}, -\code{\link{rrowl}()}, -\code{\link{rtable}()} +Other compatibility: +\code{\link[=rheader]{rheader()}}, +\code{\link[=rrowl]{rrowl()}}, +\code{\link[=rtable]{rtable()}} } \concept{compatibility} diff --git a/man/rrowl.Rd b/man/rrowl.Rd index 2982903a1a..d29013d096 100644 --- a/man/rrowl.Rd +++ b/man/rrowl.Rd @@ -20,7 +20,7 @@ rrowl( \item{...}{values in vector/list form.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr the format label (string) or formatter function to apply to the -cell values passed via \code{...}. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +cell values passed via \code{...}. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{indent}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}} @@ -28,7 +28,7 @@ cell values passed via \code{...}. See \code{\link[formatters:list_formats]{form \code{\link[formatters:table_inset]{formatters::table_inset()}} for details.} \item{round_type}{(\code{"iec"}, \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. -See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} +See \code{\link[formatters:round_fmt]{round_fmt()}} for details.} } \value{ A row object of the context-appropriate type (label or data). @@ -54,9 +54,9 @@ rrow(row.name = "row 2", c(1, 2), c(3, 4)) } \seealso{ -Other compatibility: -\code{\link{rheader}()}, -\code{\link{rrow}()}, -\code{\link{rtable}()} +Other compatibility: +\code{\link[=rheader]{rheader()}}, +\code{\link[=rrow]{rrow()}}, +\code{\link[=rtable]{rtable()}} } \concept{compatibility} diff --git a/man/rtable.Rd b/man/rtable.Rd index 1079f0c7c9..f028942719 100644 --- a/man/rtable.Rd +++ b/man/rtable.Rd @@ -24,18 +24,18 @@ rtablel(header, ..., format = NULL, hsep = default_hsep(), inset = 0L) \item{...}{rows to place in the table.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr the format label (string) or formatter function to apply to the -cell values passed via \code{...}. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for currently supported format labels.} +cell values passed via \code{...}. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for currently supported format labels.} \item{hsep}{(\code{string})\cr set of characters to be repeated as the separator between the header and body of the table when rendered as text. Defaults to a connected horizontal line (unicode 2014) in locals that use a UTF -charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:default_horizontal_sep]{formatters::set_default_hsep()}} for further +charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:set_default_hsep]{formatters::set_default_hsep()}} for further information.} \item{inset}{(\code{integer(1)})\cr the table inset for the row or table being constructed. See \code{\link[formatters:table_inset]{formatters::table_inset()}} for details.} \item{round_type}{(\code{"iec"}, \code{"iec_mod"} or \code{"sas"})\cr the type of rounding to perform. -See \code{\link[formatters:round_fmt]{formatters::round_fmt()}} for details.} +See \code{\link[formatters:round_fmt]{round_fmt()}} for details.} } \value{ A formal table object of the appropriate type (\code{ElementaryTable} or \code{TableTree}). @@ -126,9 +126,9 @@ tbl2 } \seealso{ -Other compatibility: -\code{\link{rheader}()}, -\code{\link{rrow}()}, -\code{\link{rrowl}()} +Other compatibility: +\code{\link[=rheader]{rheader()}}, +\code{\link[=rrow]{rrow()}}, +\code{\link[=rrowl]{rrowl()}} } \concept{compatibility} diff --git a/man/rtables-package.Rd b/man/rtables-package.Rd index a31d5b0012..dd6327e07d 100644 --- a/man/rtables-package.Rd +++ b/man/rtables-package.Rd @@ -6,6 +6,8 @@ \alias{rtables-package} \title{rtables: Reporting Tables} \description{ +\if{html}{\figure{logo.svg}{options: style='float: right' alt='logo' width='120'}} + Reporting tables often have structure that goes beyond simple rectangular data. The 'rtables' package provides a framework for declaring complex multi-level tabulations and then applying them to data. This framework models both tabulation and the resulting tables as hierarchical, tree-like objects which support sibling sub-tables, arbitrary splitting or grouping of data in row and column dimensions, cells containing multiple values, and the concept of contextual summary computations. A convenient pipe-able interface is provided for declaring table layouts and the corresponding computations, and then applying them to data. } \seealso{ @@ -22,6 +24,7 @@ Useful links: Authors: \itemize{ + \item Joe Zhu \email{joe.zhu@roche.com} (\href{https://orcid.org/0000-0001-7566-2787}{ORCID}) \item Gabriel Becker \email{gabembecker@gmail.com} (Original creator of the package) \item Adrian Waddell \email{adrian.waddell@gmail.com} \item Davide Garolini \email{davide.garolini@roche.com} (\href{https://orcid.org/0000-0002-1445-1369}{ORCID}) diff --git a/man/sanitize_table_struct.Rd b/man/sanitize_table_struct.Rd index 1792b53872..64eb0e14e2 100644 --- a/man/sanitize_table_struct.Rd +++ b/man/sanitize_table_struct.Rd @@ -39,8 +39,8 @@ sanitize_table_struct(badtab) } \seealso{ -Other table structure validation functions: -\code{\link{find_degen_struct}()}, -\code{\link{validate_table_struct}()} +Other table structure validation functions: +\code{\link[=find_degen_struct]{find_degen_struct()}}, +\code{\link[=validate_table_struct]{validate_table_struct()}} } \concept{table structure validation functions} diff --git a/man/sf_args.Rd b/man/sf_args.Rd index b49c12269f..00abd6fe9f 100644 --- a/man/sf_args.Rd +++ b/man/sf_args.Rd @@ -21,10 +21,10 @@ No return value. Split function argument conventions } \seealso{ -Other conventions: -\code{\link{compat_args}()}, -\code{\link{constr_args}()}, -\code{\link{gen_args}()}, -\code{\link{lyt_args}()} +Other conventions: +\code{\link[=compat_args]{compat_args()}}, +\code{\link[=constr_args]{constr_args()}}, +\code{\link[=gen_args]{gen_args()}}, +\code{\link[=lyt_args]{lyt_args()}} } \concept{conventions} diff --git a/man/sort_at_path.Rd b/man/sort_at_path.Rd index ea70dfa7cb..503c4524a0 100644 --- a/man/sort_at_path.Rd +++ b/man/sort_at_path.Rd @@ -81,9 +81,9 @@ 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[formatters:lab_name]{formatters::obj_name()}} - Retrieves the name of an object. Note this can differ from the label that is +\item \code{\link[formatters:obj_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 +\item \code{\link[formatters:obj_label]{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 diff --git a/man/split_cols_by.Rd b/man/split_cols_by.Rd index 30c2c97e25..a2ecc5793e 100644 --- a/man/split_cols_by.Rd +++ b/man/split_cols_by.Rd @@ -33,7 +33,7 @@ with labels assigned to each child (which are based on the data and type of spli \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{nested}{(\code{logical})\cr whether this layout instruction should be applied within the existing layout structure \emph{if possible} (\code{TRUE}, the default) or as a new top-level element (\code{FALSE}). Ignored if it would nest a split diff --git a/man/split_rows_by.Rd b/man/split_rows_by.Rd index 70919aee62..1392450880 100644 --- a/man/split_rows_by.Rd +++ b/man/split_rows_by.Rd @@ -41,7 +41,7 @@ analyzing a single variable.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/split_rows_by_multivar.Rd b/man/split_rows_by_multivar.Rd index 14bbff79fc..389d351e43 100644 --- a/man/split_rows_by_multivar.Rd +++ b/man/split_rows_by_multivar.Rd @@ -39,7 +39,7 @@ analyzing a single variable.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/summarize_row_groups.Rd b/man/summarize_row_groups.Rd index 79f0bed0e7..4839be826d 100644 --- a/man/summarize_row_groups.Rd +++ b/man/summarize_row_groups.Rd @@ -26,7 +26,7 @@ it can contain up to two \code{"\\\%s"}.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} diff --git a/man/tabclasses.Rd b/man/tabclasses.Rd index 1573e8fb9c..f6ae78727d 100644 --- a/man/tabclasses.Rd +++ b/man/tabclasses.Rd @@ -84,7 +84,7 @@ table for another \code{TableTree}.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.} @@ -92,16 +92,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[formatters:title_footer]{formatters::main_title()}}). Ignored for subtables.} +\item{title}{(\code{string})\cr single string to use as main title (\code{\link[formatters:main_title]{formatters::main_title()}}). 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 +\item{subtitles}{(\code{character})\cr a vector of strings to use as subtitles (\code{\link[formatters:subtitles]{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[formatters:title_footer]{formatters::main_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:main_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[formatters:title_footer]{formatters::prov_footer()}}), where every element is printed on a separate line.} +(\code{\link[formatters:prov_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 @@ -109,7 +109,7 @@ element is printed on a separate line. Ignored for subtables.} \item{hsep}{(\code{string})\cr set of characters to be repeated as the separator between the header and body of the table when rendered as text. Defaults to a connected horizontal line (unicode 2014) in locals that use a UTF -charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:default_horizontal_sep]{formatters::set_default_hsep()}} for further +charset, and to \code{-} elsewhere (with a once per session warning). See \code{\link[formatters:set_default_hsep]{formatters::set_default_hsep()}} for further information.} \item{trailing_section_div}{(\code{string})\cr string which will be used as a section divider after the printing diff --git a/man/trim_levels_in_facets.Rd b/man/trim_levels_in_facets.Rd index be29aabe15..89e6fd342e 100644 --- a/man/trim_levels_in_facets.Rd +++ b/man/trim_levels_in_facets.Rd @@ -18,11 +18,11 @@ Trim levels of another variable from each facet (post-processing split step) \seealso{ \code{\link[=make_split_fun]{make_split_fun()}} -Other make_custom_split: -\code{\link{add_combo_facet}()}, -\code{\link{drop_facet_levels}()}, -\code{\link{make_split_fun}()}, -\code{\link{make_split_result}()}, -\code{\link{restrict_facets}()} +Other make_custom_split: +\code{\link[=add_combo_facet]{add_combo_facet()}}, +\code{\link[=drop_facet_levels]{drop_facet_levels()}}, +\code{\link[=make_split_fun]{make_split_fun()}}, +\code{\link[=make_split_result]{make_split_result()}}, +\code{\link[=restrict_facets]{restrict_facets()}} } \concept{make_custom_split} diff --git a/man/validate_table_struct.Rd b/man/validate_table_struct.Rd index 3f68f8bcf4..323c633f6a 100644 --- a/man/validate_table_struct.Rd +++ b/man/validate_table_struct.Rd @@ -46,8 +46,8 @@ assert_valid_table(rtable("oops")) } \seealso{ -Other table structure validation functions: -\code{\link{find_degen_struct}()}, -\code{\link{sanitize_table_struct}()} +Other table structure validation functions: +\code{\link[=find_degen_struct]{find_degen_struct()}}, +\code{\link[=sanitize_table_struct]{sanitize_table_struct()}} } \concept{table structure validation functions} diff --git a/man/varcuts.Rd b/man/varcuts.Rd index 360bdd549f..c5b387c2a7 100644 --- a/man/varcuts.Rd +++ b/man/varcuts.Rd @@ -126,7 +126,7 @@ analyzing a single variable.} \item{format}{(\code{string}, \code{function}, or \code{list})\cr format associated with this split. Formats can be declared via strings (\code{"xx.x"}) or function. In cases such as \code{analyze} calls, they can be character vectors or lists of -functions. See \code{\link[formatters:list_formats]{formatters::list_valid_format_labels()}} for a list of all available format strings.} +functions. See \code{\link[formatters:list_valid_format_labels]{formatters::list_valid_format_labels()}} for a list of all available format strings.} \item{na_str}{(\code{string})\cr string that should be displayed when the value of \code{x} is missing. Defaults to \code{"NA"}.}