Skip to content

Commit

Permalink
adding links
Browse files Browse the repository at this point in the history
  • Loading branch information
Melkiades committed Aug 25, 2023
1 parent 2bbc0dd commit 0394e23
Show file tree
Hide file tree
Showing 9 changed files with 57 additions and 29 deletions.
15 changes: 10 additions & 5 deletions R/argument_conventions.R
Original file line number Diff line number Diff line change
Expand Up @@ -205,13 +205,18 @@ lyt_args <- function(lyt, var, vars, label, labels_var, varlabels, varnames, spl
#' when tabulating row group summaries.
#' @param child_names character. Names to be given to the sub splits contained
#' by a compound split (typically a `AnalyzeMultiVars` split object).
#' @param title character(1). Main title. Ignored for subtables.
#' @param subtitles character. Subtitles. Ignored for subtables.
#' @param main_footer character. Main global (non-referential) footer materials.
#' @param prov_footer character. Provenance-related global footer materials.
#' @param title character(1). Main title [main_title()] is a single string.
#' Ignored for subtables.
#' @param subtitles character. Subtitles [subtitles()] can be vector of strings;
#' hence every element is printed in a separate line. Ignored for subtables.
#' @param main_footer character. Main global (non-referential) footer materials
#' [main_footer()]. If it a vector of strings, they will be printed on different
#' lines.
#' @param prov_footer character. Provenance-related global footer materials
#' [prov_footer()]. It can be also a vector of strings, printed on different lines.
#' Generally should not be modified by hand.
#' @param footnotes list or NULL. Referential footnotes to be applied at current
#' level
#' level [fnotes_at_path()].
#' @param trailing_sep character(1). 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
Expand Down
5 changes: 5 additions & 0 deletions R/colby_constructors.R
Original file line number Diff line number Diff line change
Expand Up @@ -1818,6 +1818,7 @@ list_wrap_df <- function(f) {
#' formats result in an error. Formats in the form of functions are not supported for
#' `colcount` format. See [formatters::list_valid_format_labels()] for
#' the list of valid format labels to select from.
#'
#'
#' @inherit split_cols_by return
#'
Expand All @@ -1827,6 +1828,10 @@ list_wrap_df <- function(f) {
#' 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 spans more than one line can be supplied as a character vector to maintain
#' indentation on multiple lines.
#'
#' @examples
#'
#' lyt <- basic_table() %>%
Expand Down
3 changes: 0 additions & 3 deletions R/tt_dotabulation.R
Original file line number Diff line number Diff line change
Expand Up @@ -1003,9 +1003,6 @@ recursive_applysplit <- function(df,
#' In particular, this means that in the case of splitting based on cuts of the
#' data, any dynamic cuts will have been calculated based on \code{df} and
#' simply re-used for the count calculation.
#'
#' Footers spanning more than one line can be supplied as a character vector to
#' maintain indentation. See \link[formatters]{main_footer}.
#'
#' @note When overriding the column counts or totals care must be taken that,
#' e.g., `length()` or `nrow()` are not called within tabulation functions,
Expand Down
17 changes: 13 additions & 4 deletions man/basic_table.Rd

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

3 changes: 0 additions & 3 deletions man/build_table.Rd

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

15 changes: 10 additions & 5 deletions man/constr_args.Rd

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

13 changes: 9 additions & 4 deletions man/qtable_layout.Rd

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

2 changes: 1 addition & 1 deletion man/rowclasses.Rd

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

13 changes: 9 additions & 4 deletions man/tabclasses.Rd

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

0 comments on commit 0394e23

Please sign in to comment.