diff --git a/R/abnormal.R b/R/abnormal.R index 05ccbcada9..13f7e1debb 100644 --- a/R/abnormal.R +++ b/R/abnormal.R @@ -23,8 +23,9 @@ #' for example, `abnormal = list(Low = c("LOW", "LOW LOW"), High = c("HIGH", "HIGH HIGH"))`. #' @param exclude_base_abn (`flag`)\cr whether to exclude subjects with baseline abnormality #' from numerator and denominator. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("abnormal")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("abnormal"))`` #' #' @note #' * `count_abnormal()` only considers a single variable that contains multiple abnormal levels. diff --git a/R/abnormal_by_baseline.R b/R/abnormal_by_baseline.R index 4ac5c10f4a..b85e0fd20c 100644 --- a/R/abnormal_by_baseline.R +++ b/R/abnormal_by_baseline.R @@ -29,8 +29,9 @@ #' #' @inheritParams argument_convention #' @param abnormal (`character`)\cr values identifying the abnormal range level(s) in `.var`. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("abnormal_by_baseline")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("abnormal_by_baseline"))`` #' #' @note #' * `df` should be filtered to include only post-baseline records. diff --git a/R/abnormal_by_marked.R b/R/abnormal_by_marked.R index d9eae8989f..c6d5fdc7e3 100644 --- a/R/abnormal_by_marked.R +++ b/R/abnormal_by_marked.R @@ -28,8 +28,9 @@ #' @inheritParams argument_convention #' @param category (`list`)\cr a list with different marked category names for single #' and last or replicated. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("abnormal_by_marked")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("abnormal_by_marked"))`` #' #' @note `Single, not last` and `Last or replicated` levels are mutually exclusive. If a patient has #' abnormalities that meet both the `Single, not last` and `Last or replicated` criteria, then the diff --git a/R/abnormal_by_worst_grade.R b/R/abnormal_by_worst_grade.R index cb0376358d..214876deb0 100644 --- a/R/abnormal_by_worst_grade.R +++ b/R/abnormal_by_worst_grade.R @@ -27,8 +27,9 @@ #' splits, one on variable `param` and one on variable `grade_dir`. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("abnormal_by_worst_grade")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("abnormal_by_worst_grade"))`` #' #' @seealso [h_adlb_abnormal_by_worst_grade()] which pre-processes ADLB data frames to be used in #' [count_abnormal_by_worst_grade()]. diff --git a/R/abnormal_by_worst_grade_worsen.R b/R/abnormal_by_worst_grade_worsen.R index ae1d8c60db..3bdc0d88cb 100644 --- a/R/abnormal_by_worst_grade_worsen.R +++ b/R/abnormal_by_worst_grade_worsen.R @@ -28,8 +28,9 @@ #' * `id` (`string`)\cr subject variable name. #' * `baseline_var` (`string`)\cr name of the data column containing baseline toxicity variable. #' * `direction_var` (`string`)\cr see `direction_var` for more details. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("abnormal_by_worst_grade_worsen")` -#' to see all available statistics. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("abnormal_by_worst_grade_worsen"))`` #' #' @seealso Relevant helper functions [h_adlb_worsen()] and [h_worsen_counter()] which are used within #' [s_count_abnormal_lab_worsen_by_baseline()] to process input data. diff --git a/R/analyze_variables.R b/R/analyze_variables.R index 1711b8a126..5a8ae1c31f 100644 --- a/R/analyze_variables.R +++ b/R/analyze_variables.R @@ -45,9 +45,11 @@ control_analyze_vars <- function(conf_level = 0.95, #' columns) will be considered (`.df_row[[.var]]`, see [`rtables::additional_fun_params`]) and not the whole dataset. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("analyze_vars_numeric")` to see -#' statistics available for numeric variables, and `get_stats("analyze_vars_counts")` for statistics available -#' for non-numeric variables. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options for numeric variables are: ``r shQuote(get_stats("analyze_vars_numeric"))`` +#' +#' Options for non-numeric variables are: ``r shQuote(get_stats("analyze_vars_counts"))`` #' #' @name analyze_variables #' @order 1 diff --git a/R/compare_variables.R b/R/compare_variables.R index 3e9eb2ba9d..b84183a53e 100644 --- a/R/compare_variables.R +++ b/R/compare_variables.R @@ -14,9 +14,11 @@ #' statistic. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run -#' `get_stats("analyze_vars_numeric", add_pval = TRUE)` to see statistics available for numeric variables, and -#' `get_stats("analyze_vars_counts", add_pval = TRUE)` for statistics available for non-numeric variables. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options for numeric variables are: ``r shQuote(get_stats("analyze_vars_numeric", add_pval = TRUE))`` +#' +#' Options for non-numeric variables are: ``r shQuote(get_stats("analyze_vars_counts", add_pval = TRUE))`` #' #' @note #' * For factor variables, `denom` for factor proportions can only be `n` since the purpose is to compare proportions diff --git a/R/count_cumulative.R b/R/count_cumulative.R index 8a73996fb4..90ee067f8b 100644 --- a/R/count_cumulative.R +++ b/R/count_cumulative.R @@ -14,8 +14,9 @@ #' @inheritParams h_count_cumulative #' @inheritParams argument_convention #' @param thresholds (`numeric`)\cr vector of cutoff values for the counts. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_cumulative")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_cumulative"))`` #' #' @seealso Relevant helper function [h_count_cumulative()], and descriptive function [d_count_cumulative()]. #' diff --git a/R/count_missed_doses.R b/R/count_missed_doses.R index 64eb2587c0..239b40ad01 100644 --- a/R/count_missed_doses.R +++ b/R/count_missed_doses.R @@ -12,8 +12,9 @@ #' @inheritParams s_count_cumulative #' @inheritParams argument_convention #' @param thresholds (`numeric`)\cr minimum number of missed doses the patients had. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_missed_doses")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_missed_doses"))`` #' #' @seealso #' * Relevant description function [d_count_missed_doses()] which generates labels for [count_missed_doses()]. diff --git a/R/count_occurrences.R b/R/count_occurrences.R index 454457e906..73052eb08c 100644 --- a/R/count_occurrences.R +++ b/R/count_occurrences.R @@ -17,8 +17,9 @@ #' @inheritParams argument_convention #' @param drop (`flag`)\cr whether non-appearing occurrence levels should be dropped from the resulting table. #' Note that in that case the remaining occurrence levels in the table are sorted alphabetically. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_occurrences")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_occurrences"))`` #' #' @note By default, occurrences which don't appear in a given row split are dropped from the table and #' the occurrences in the table are sorted alphabetically per row split. Therefore, the corresponding layout diff --git a/R/count_occurrences_by_grade.R b/R/count_occurrences_by_grade.R index d9284a9bf2..d77a049a7a 100644 --- a/R/count_occurrences_by_grade.R +++ b/R/count_occurrences_by_grade.R @@ -24,8 +24,9 @@ #' @param only_grade_groups (`flag`)\cr whether only the specified grade groups should be #' included, with individual grade rows removed (`TRUE`), or all grades and grade groups #' should be displayed (`FALSE`). -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_occurrences_by_grade")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_occurrences_by_grade"))`` #' #' @seealso Relevant helper function [h_append_grade_groups()]. #' diff --git a/R/count_patients_events_in_cols.R b/R/count_patients_events_in_cols.R index f7c47d40ba..a2321c2dbe 100644 --- a/R/count_patients_events_in_cols.R +++ b/R/count_patients_events_in_cols.R @@ -19,9 +19,10 @@ #' that corresponding table cells will stay blank. #' @param custom_label (`string` or `NULL`)\cr if provided and `labelstr` is empty then this will #' be used as label. -#' @param .stats (`character`)\cr statistics to select for the table. Run -#' `get_stats("summarize_patients_events_in_cols")` to see available statistics for this function, in addition -#' to any added using `filters_list`. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' In addition to any statistics added using `filters_list`, statistic options are: +#' ``r shQuote(get_stats("summarize_patients_events_in_cols"))`` #' #' @name count_patients_events_in_cols #' @order 1 diff --git a/R/count_patients_with_event.R b/R/count_patients_with_event.R index 0c00ff28ec..fb4275fcf6 100644 --- a/R/count_patients_with_event.R +++ b/R/count_patients_with_event.R @@ -17,8 +17,9 @@ #' Multiple column names and flags are accepted in this format #' `c("column_name1" = "flag1", "column_name2" = "flag2")`. #' Note that only equality is being accepted as condition. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_patients_with_event")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_patients_with_event"))`` #' #' @seealso [count_patients_with_flags] #' diff --git a/R/count_patients_with_flags.R b/R/count_patients_with_flags.R index f14dcb259f..e7fd062639 100644 --- a/R/count_patients_with_flags.R +++ b/R/count_patients_with_flags.R @@ -15,8 +15,9 @@ #' @param flag_variables (`character`)\cr a vector specifying the names of `logical` variables from analysis dataset #' used for counting the number of unique identifiers. #' @param flag_labels (`character`)\cr vector of labels to use for flag variables. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_patients_with_flags")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_patients_with_flags"))`` #' #' @seealso [count_patients_with_event] #' diff --git a/R/count_values.R b/R/count_values.R index 961ea77f70..4009e543a7 100644 --- a/R/count_values.R +++ b/R/count_values.R @@ -11,8 +11,9 @@ #' #' @inheritParams argument_convention #' @param values (`character`)\cr specific values that should be counted. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("count_values")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("count_values"))`` #' #' @note #' * For `factor` variables, `s_count_values` checks whether `values` are all included in the levels of `x` diff --git a/R/estimate_multinomial_rsp.R b/R/estimate_multinomial_rsp.R index 58bab1cad5..8f6e2fce7a 100644 --- a/R/estimate_multinomial_rsp.R +++ b/R/estimate_multinomial_rsp.R @@ -7,8 +7,9 @@ #' `var`, should be a factor variable, the values of which will be used as labels within the output table. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("estimate_multinomial_response")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("estimate_multinomial_response"))`` #' #' @seealso Relevant description function [d_onco_rsp_label()]. #' diff --git a/R/estimate_proportion.R b/R/estimate_proportion.R index ebe785a7d1..660259c2da 100644 --- a/R/estimate_proportion.R +++ b/R/estimate_proportion.R @@ -10,12 +10,13 @@ #' #' @inheritParams prop_strat_wilson #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("estimate_proportion")` -#' to see available statistics for this function. #' @param method (`string`)\cr the method used to construct the confidence interval #' for proportion of successful outcomes; one of `waldcc`, `wald`, `clopper-pearson`, #' `wilson`, `wilsonc`, `strat_wilson`, `strat_wilsonc`, `agresti-coull` or `jeffreys`. #' @param long (`flag`)\cr whether a long description is required. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("estimate_proportion"))`` #' #' @seealso [h_proportions] #' diff --git a/R/incidence_rate.R b/R/incidence_rate.R index fd26d48656..32c1b56f48 100644 --- a/R/incidence_rate.R +++ b/R/incidence_rate.R @@ -19,8 +19,9 @@ #' @param n_events (`string`)\cr name of integer variable indicating whether an event has been observed (1) or not (0). #' @param id_var (`string`)\cr name of variable used as patient identifier if `"n_unique"` is included in `.stats`. #' Defaults to `"USUBJID"`. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("estimate_incidence_rate")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("estimate_incidence_rate"))`` #' @param summarize (`flag`)\cr whether the function should act as an analyze function (`summarize = FALSE`), or a #' summarize function (`summarize = TRUE`). Defaults to `FALSE`. #' @param label_fmt (`string`)\cr how labels should be formatted after a row split occurs if `summarize = TRUE`. The diff --git a/R/odds_ratio.R b/R/odds_ratio.R index 16bb58ac06..2d506d61f5 100644 --- a/R/odds_ratio.R +++ b/R/odds_ratio.R @@ -11,8 +11,9 @@ #' #' @inheritParams split_cols_by_groups #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("estimate_odds_ratio")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("estimate_odds_ratio"))`` #' @param method (`string`)\cr whether to use the correct (`"exact"`) calculation in the conditional likelihood or one #' of the approximations. See [survival::clogit()] for details. #' diff --git a/R/prop_diff.R b/R/prop_diff.R index ea5078f873..919053464e 100644 --- a/R/prop_diff.R +++ b/R/prop_diff.R @@ -12,8 +12,9 @@ #' @inheritParams prop_diff_strat_nc #' @inheritParams argument_convention #' @param method (`string`)\cr the method used for the confidence interval estimation. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("estimate_proportion_diff")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("estimate_proportion_diff"))`` #' #' @seealso [d_proportion_diff()] #' diff --git a/R/prop_diff_test.R b/R/prop_diff_test.R index 86188e673d..17dceebe58 100644 --- a/R/prop_diff_test.R +++ b/R/prop_diff_test.R @@ -10,8 +10,9 @@ #' @inheritParams argument_convention #' @param method (`string`)\cr one of `chisq`, `cmh`, `fisher`, or `schouten`; specifies the test used #' to calculate the p-value. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("test_proportion_diff")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("test_proportion_diff"))`` #' #' @seealso [h_prop_diff_test] #' diff --git a/R/summarize_ancova.R b/R/summarize_ancova.R index 9b2dc6d80a..b7a466124c 100644 --- a/R/summarize_ancova.R +++ b/R/summarize_ancova.R @@ -17,8 +17,9 @@ #' @inheritParams argument_convention #' @param interaction_y (`string` or `flag`)\cr a selected item inside of the `interaction_item` variable which will be #' used to select the specific ANCOVA results. if the interaction is not needed, the default option is `FALSE`. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("summarize_ancova")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("summarize_ancova"))`` #' #' @name summarize_ancova #' @order 1 diff --git a/R/summarize_change.R b/R/summarize_change.R index fe55a19e68..bf76ca7424 100644 --- a/R/summarize_change.R +++ b/R/summarize_change.R @@ -12,8 +12,9 @@ #' or the change from baseline values (post-baseline) are then summarized. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("analyze_vars_numeric)` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("analyze_vars_numeric"))`` #' #' @name summarize_change #' @order 1 diff --git a/R/summarize_coxreg.R b/R/summarize_coxreg.R index fc0f4bb722..c70a8c9424 100644 --- a/R/summarize_coxreg.R +++ b/R/summarize_coxreg.R @@ -5,8 +5,9 @@ #' Fits a Cox regression model and estimates hazard ratio to describe the effect size in a survival analysis. #' #' @inheritParams argument_convention -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("summarize_coxreg")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("summarize_coxreg"))`` #' #' @details Cox models are the most commonly used methods to estimate the magnitude of #' the effect in survival analysis. It assumes proportional hazards: the ratio diff --git a/R/summarize_glm_count.R b/R/summarize_glm_count.R index 8c45995b09..84c9e7c00b 100644 --- a/R/summarize_glm_count.R +++ b/R/summarize_glm_count.R @@ -14,8 +14,9 @@ #' @param rate_mean_method (`character(1)`)\cr method used to estimate the mean odds ratio. Defaults to `emmeans`. #' see details for more information. #' @param scale (`numeric(1)`)\cr linear scaling factor for rate and confidence intervals. Defaults to `1`. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("summarize_glm_count")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("summarize_glm_count"))`` #' #' @details #' `summarize_glm_count()` uses `s_glm_count()` to calculate the statistics for the table. This diff --git a/R/summarize_num_patients.R b/R/summarize_num_patients.R index d7deb2f4b7..2fc5c3619d 100644 --- a/R/summarize_num_patients.R +++ b/R/summarize_num_patients.R @@ -19,8 +19,9 @@ #' `nonunique` records. #' @param unique_count_suffix (`flag`)\cr whether the `"(n)"` suffix should be added to `unique_count` labels. #' Defaults to `TRUE`. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("summarize_num_patients")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("summarize_num_patients"))`` #' #' @name summarize_num_patients #' @order 1 diff --git a/R/summarize_patients_exposure_in_cols.R b/R/summarize_patients_exposure_in_cols.R index 44d7f66bf6..7269bc3aa0 100644 --- a/R/summarize_patients_exposure_in_cols.R +++ b/R/summarize_patients_exposure_in_cols.R @@ -21,8 +21,9 @@ #' @inheritParams argument_convention #' @param ex_var (`string`)\cr name of the variable in `df` containing exposure values. #' @param custom_label (`string` or `NULL`)\cr if provided and `labelstr` is empty, this will be used as label. -#' @param .stats (`character`)\cr statistics to select for the table. Run -#' `get_stats("analyze_patients_exposure_in_cols")` to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("analyze_patients_exposure_in_cols"))`` #' #' @name summarize_patients_exposure_in_cols #' @order 1 diff --git a/R/survival_coxph_pairwise.R b/R/survival_coxph_pairwise.R index 88ec24b68e..823c159379 100644 --- a/R/survival_coxph_pairwise.R +++ b/R/survival_coxph_pairwise.R @@ -20,8 +20,9 @@ #' * `ties` (`string`)\cr specifying the method for tie handling. Default is `"efron"`, #' can also be set to `"breslow"` or `"exact"`. See more in [survival::coxph()]. #' * `conf_level` (`proportion`)\cr confidence level of the interval for HR. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("coxph_pairwise")` -#' to see available statistics for this function. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("coxph_pairwise"))`` #' #' @name survival_coxph_pairwise #' @order 1 diff --git a/R/survival_time.R b/R/survival_time.R index fd13f0ce73..de12ff681d 100644 --- a/R/survival_time.R +++ b/R/survival_time.R @@ -16,11 +16,12 @@ #' * `quantiles` (`numeric`)\cr vector of length two to specify the quantiles of survival time. #' @param ref_fn_censor (`flag`)\cr whether referential footnotes indicating censored observations should be printed #' when the `range` statistic is included. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("surv_time")` -#' to see available statistics for this function. #' @param .indent_mods (named `integer`)\cr indent modifiers for the labels. Each element of the vector #' should be a name-value pair with name corresponding to a statistic specified in `.stats` and value the indentation #' for that statistic's row label. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("surv_time"))`` #' #' @examples #' library(dplyr) diff --git a/R/survival_timepoint.R b/R/survival_timepoint.R index 021e8f2e6d..0bbb0e2248 100644 --- a/R/survival_timepoint.R +++ b/R/survival_timepoint.R @@ -21,11 +21,12 @@ #' control), or `"both"`. #' @param table_names_suffix (`string`)\cr optional suffix for the `table_names` used for the `rtables` to #' avoid warnings from duplicate table names. -#' @param .stats (`character`)\cr statistics to select for the table. Run `get_stats("surv_timepoint")` -#' to see available statistics for this function. #' @param .indent_mods (named `integer`)\cr indent modifiers for the labels. Each element of the vector #' should be a name-value pair with name corresponding to a statistic specified in `.stats` and value the indentation #' for that statistic's row label. +#' @param .stats (`character`)\cr statistics to select for the table. +#' +#' Options are: ``r shQuote(get_stats("surv_timepoint"))`` #' #' @name survival_timepoint #' @order 1 diff --git a/man/abnormal.Rd b/man/abnormal.Rd index 092d1f1a42..5461d3447a 100644 --- a/man/abnormal.Rd +++ b/man/abnormal.Rd @@ -62,8 +62,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("abnormal")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \code{'fraction'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/abnormal_by_baseline.Rd b/man/abnormal_by_baseline.Rd index e8bbac47c2..6f14569d2b 100644 --- a/man/abnormal_by_baseline.Rd +++ b/man/abnormal_by_baseline.Rd @@ -57,8 +57,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("abnormal_by_baseline")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \code{'fraction'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/abnormal_by_marked.Rd b/man/abnormal_by_marked.Rd index 946a162c67..dd7764346f 100644 --- a/man/abnormal_by_marked.Rd +++ b/man/abnormal_by_marked.Rd @@ -53,8 +53,9 @@ underneath analyses, which is not allowed.} \item{...}{additional arguments for the lower level functions.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("abnormal_by_marked")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'count_fraction', 'count_fraction_fixed_dp'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/abnormal_by_worst_grade.Rd b/man/abnormal_by_worst_grade.Rd index 2f17eabe1b..6ec9bb7aca 100644 --- a/man/abnormal_by_worst_grade.Rd +++ b/man/abnormal_by_worst_grade.Rd @@ -47,8 +47,9 @@ underneath analyses, which is not allowed.} \item{...}{additional arguments for the lower level functions.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("abnormal_by_worst_grade")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'count_fraction', 'count_fraction_fixed_dp'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/abnormal_by_worst_grade_worsen.Rd b/man/abnormal_by_worst_grade_worsen.Rd index 27dfcd987e..4afbdddfde 100644 --- a/man/abnormal_by_worst_grade_worsen.Rd +++ b/man/abnormal_by_worst_grade_worsen.Rd @@ -54,8 +54,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("abnormal_by_worst_grade_worsen")} -to see all available statistics.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \code{'fraction'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/analyze_variables.Rd b/man/analyze_variables.Rd index 1c7056ed49..ac83afe9f1 100644 --- a/man/analyze_variables.Rd +++ b/man/analyze_variables.Rd @@ -113,9 +113,11 @@ times, to avoid warnings from \code{rtables}.} \item{section_div}{(\code{string})\cr string which should be repeated as a section divider after each group defined by this split instruction, or \code{NA_character_} (the default) for no section divider.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("analyze_vars_numeric")} to see -statistics available for numeric variables, and \code{get_stats("analyze_vars_counts")} for statistics available -for non-numeric variables.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options for numeric variables are: \verb{'n', 'sum', 'mean', 'sd', 'se', 'mean_sd', 'mean_se', 'mean_ci', 'mean_sei', 'mean_sdi', 'mean_pval', 'median', 'mad', 'median_ci', 'quantiles', 'iqr', 'range', 'min', 'max', 'median_range', 'cv', 'geom_mean', 'geom_mean_ci', 'geom_cv'} + +Options for non-numeric variables are: \verb{'n', 'count', 'count_fraction', 'count_fraction_fixed_dp', 'fraction', 'n_blq'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/compare_variables.Rd b/man/compare_variables.Rd index 7fc9cce246..5f9d0cd1f7 100644 --- a/man/compare_variables.Rd +++ b/man/compare_variables.Rd @@ -71,9 +71,11 @@ times, to avoid warnings from \code{rtables}.} \item{section_div}{(\code{string})\cr string which should be repeated as a section divider after each group defined by this split instruction, or \code{NA_character_} (the default) for no section divider.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run -\code{get_stats("analyze_vars_numeric", add_pval = TRUE)} to see statistics available for numeric variables, and -\code{get_stats("analyze_vars_counts", add_pval = TRUE)} for statistics available for non-numeric variables.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options for numeric variables are: \verb{'n', 'sum', 'mean', 'sd', 'se', 'mean_sd', 'mean_se', 'mean_ci', 'mean_sei', 'mean_sdi', 'mean_pval', 'median', 'mad', 'median_ci', 'quantiles', 'iqr', 'range', 'min', 'max', 'median_range', 'cv', 'geom_mean', 'geom_mean_ci', 'geom_cv', 'pval'} + +Options for non-numeric variables are: \verb{'n', 'count', 'count_fraction', 'count_fraction_fixed_dp', 'fraction', 'n_blq', 'pval_counts'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_cumulative.Rd b/man/count_cumulative.Rd index 9df33c91f2..b5cba3acd5 100644 --- a/man/count_cumulative.Rd +++ b/man/count_cumulative.Rd @@ -69,8 +69,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_cumulative")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'count_fraction', 'count_fraction_fixed_dp'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_missed_doses.Rd b/man/count_missed_doses.Rd index 1af24614a6..3b2768f0e3 100644 --- a/man/count_missed_doses.Rd +++ b/man/count_missed_doses.Rd @@ -51,8 +51,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_missed_doses")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'count_fraction', 'count_fraction_fixed_dp'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_occurrences.Rd b/man/count_occurrences.Rd index 60d8037613..856f6f29e1 100644 --- a/man/count_occurrences.Rd +++ b/man/count_occurrences.Rd @@ -94,8 +94,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_occurrences")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'count', 'count_fraction', 'count_fraction_fixed_dp', 'fraction'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_occurrences_by_grade.Rd b/man/count_occurrences_by_grade.Rd index a3946ad05a..547fa84d69 100644 --- a/man/count_occurrences_by_grade.Rd +++ b/man/count_occurrences_by_grade.Rd @@ -98,8 +98,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_occurrences_by_grade")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'count_fraction', 'count_fraction_fixed_dp'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_patients_events_in_cols.Rd b/man/count_patients_events_in_cols.Rd index 48879b8b25..3fa181cc36 100644 --- a/man/count_patients_events_in_cols.Rd +++ b/man/count_patients_events_in_cols.Rd @@ -44,9 +44,10 @@ that corresponding table cells will stay blank.} \item{...}{additional arguments for the lower level functions.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run -\code{get_stats("summarize_patients_events_in_cols")} to see available statistics for this function, in addition -to any added using \code{filters_list}.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +In addition to any statistics added using \code{filters_list}, statistic options are: +\verb{'unique', 'all'}} \item{.labels}{(named \code{character})\cr labels for the statistics (without indent).} diff --git a/man/count_patients_with_event.Rd b/man/count_patients_with_event.Rd index 206b0783f4..841bc102e5 100644 --- a/man/count_patients_with_event.Rd +++ b/man/count_patients_with_event.Rd @@ -65,8 +65,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_patients_with_event")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'count', 'count_fraction', 'count_fraction_fixed_dp', 'n_blq'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_patients_with_flags.Rd b/man/count_patients_with_flags.Rd index f435aaa7ee..1e9fe8a013 100644 --- a/man/count_patients_with_flags.Rd +++ b/man/count_patients_with_flags.Rd @@ -73,8 +73,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_patients_with_flags")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'count', 'count_fraction', 'count_fraction_fixed_dp', 'n_blq'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/count_values.Rd b/man/count_values.Rd index 9965125593..91c8660aa9 100644 --- a/man/count_values.Rd +++ b/man/count_values.Rd @@ -65,8 +65,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("count_values")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'count', 'count_fraction', 'count_fraction_fixed_dp', 'n_blq'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/estimate_multinomial_rsp.Rd b/man/estimate_multinomial_rsp.Rd index 6b687737cb..d0ae7d2df8 100644 --- a/man/estimate_multinomial_rsp.Rd +++ b/man/estimate_multinomial_rsp.Rd @@ -44,8 +44,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("estimate_multinomial_response")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n_prop', 'prop_ci'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/estimate_proportion.Rd b/man/estimate_proportion.Rd index 7cc67cc094..4f3fe2c6d7 100644 --- a/man/estimate_proportion.Rd +++ b/man/estimate_proportion.Rd @@ -86,8 +86,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("estimate_proportion")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n_prop', 'prop_ci'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/incidence_rate.Rd b/man/incidence_rate.Rd index 0d35aa7a13..960119f8d9 100644 --- a/man/incidence_rate.Rd +++ b/man/incidence_rate.Rd @@ -93,8 +93,9 @@ string should use \code{"\%s"} to represent row split levels, and \code{"\%.labe \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("estimate_incidence_rate")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'person_years', 'n_events', 'rate', 'rate_ci', 'n_unique', 'n_rate'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/odds_ratio.Rd b/man/odds_ratio.Rd index b0361d3410..6dd270d9a6 100644 --- a/man/odds_ratio.Rd +++ b/man/odds_ratio.Rd @@ -77,8 +77,9 @@ times, to avoid warnings from \code{rtables}.} \item{var_labels}{(\code{character})\cr variable labels.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("estimate_odds_ratio")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'or_ci', 'n_tot'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/prop_diff.Rd b/man/prop_diff.Rd index 70b1e14056..658a31c49d 100644 --- a/man/prop_diff.Rd +++ b/man/prop_diff.Rd @@ -80,8 +80,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("estimate_proportion_diff")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'diff', 'diff_ci'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/prop_diff_test.Rd b/man/prop_diff_test.Rd index e5c9b1055b..5eb9264ff0 100644 --- a/man/prop_diff_test.Rd +++ b/man/prop_diff_test.Rd @@ -67,8 +67,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("test_proportion_diff")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \code{'pval'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/summarize_ancova.Rd b/man/summarize_ancova.Rd index 57d4998298..b4ea31316a 100644 --- a/man/summarize_ancova.Rd +++ b/man/summarize_ancova.Rd @@ -85,8 +85,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("summarize_ancova")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'lsmean', 'lsmean_diff', 'lsmean_diff_ci', 'pval'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/summarize_change.Rd b/man/summarize_change.Rd index 50197c5bf9..40b05f423c 100644 --- a/man/summarize_change.Rd +++ b/man/summarize_change.Rd @@ -42,8 +42,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \verb{get_stats("analyze_vars_numeric)} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'sum', 'mean', 'sd', 'se', 'mean_sd', 'mean_se', 'mean_ci', 'mean_sei', 'mean_sdi', 'mean_pval', 'median', 'mad', 'median_ci', 'quantiles', 'iqr', 'range', 'min', 'max', 'median_range', 'cv', 'geom_mean', 'geom_mean_ci', 'geom_cv'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/summarize_glm_count.Rd b/man/summarize_glm_count.Rd index 8b693c74e8..5cc315363f 100644 --- a/man/summarize_glm_count.Rd +++ b/man/summarize_glm_count.Rd @@ -86,8 +86,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("summarize_glm_count")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n', 'rate', 'rate_ci', 'rate_ratio', 'rate_ratio_ci', 'pval'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/summarize_num_patients.Rd b/man/summarize_num_patients.Rd index abf297d266..1f0cfa1d3a 100644 --- a/man/summarize_num_patients.Rd +++ b/man/summarize_num_patients.Rd @@ -78,8 +78,9 @@ Defaults to \code{TRUE}.} possible (\code{TRUE}, the default) or as a new top-level element (\code{FALSE}). Ignored if it would nest a split. underneath analyses, which is not allowed.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("summarize_num_patients")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'unique', 'nonunique', 'unique_count'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/summarize_patients_exposure_in_cols.Rd b/man/summarize_patients_exposure_in_cols.Rd index a3c73d3b66..8dcdf6218d 100644 --- a/man/summarize_patients_exposure_in_cols.Rd +++ b/man/summarize_patients_exposure_in_cols.Rd @@ -80,8 +80,9 @@ column split has been done already earlier in the layout pipe.} \item{na_str}{(\code{string})\cr string used to replace all \code{NA} or empty values in the output.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run -\code{get_stats("analyze_patients_exposure_in_cols")} to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'n_patients', 'sum_exposure'}} \item{.labels}{(named \code{character})\cr labels for the statistics (without indent).} diff --git a/man/survival_coxph_pairwise.Rd b/man/survival_coxph_pairwise.Rd index 56231f2082..a4539ca36b 100644 --- a/man/survival_coxph_pairwise.Rd +++ b/man/survival_coxph_pairwise.Rd @@ -79,8 +79,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("coxph_pairwise")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'pvalue', 'hr', 'hr_ci', 'n_tot', 'n_tot_events'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/survival_time.Rd b/man/survival_time.Rd index 6b658b0e3d..4a150208da 100644 --- a/man/survival_time.Rd +++ b/man/survival_time.Rd @@ -76,8 +76,9 @@ underneath analyses, which is not allowed.} \item{table_names}{(\code{character})\cr this can be customized in the case that the same \code{vars} are analyzed multiple times, to avoid warnings from \code{rtables}.} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("surv_time")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'median', 'median_ci', 'quantiles', 'range_censor', 'range_event', 'range'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.} diff --git a/man/survival_timepoint.Rd b/man/survival_timepoint.Rd index e6cbeb22e2..2420718a1b 100644 --- a/man/survival_timepoint.Rd +++ b/man/survival_timepoint.Rd @@ -105,8 +105,9 @@ avoid warnings from duplicate table names.} \item{show_labels}{(\code{string})\cr label visibility: one of "default", "visible" and "hidden".} -\item{.stats}{(\code{character})\cr statistics to select for the table. Run \code{get_stats("surv_timepoint")} -to see available statistics for this function.} +\item{.stats}{(\code{character})\cr statistics to select for the table. + +Options are: \verb{'pt_at_risk', 'event_free_rate', 'rate_se', 'rate_ci', 'rate_diff', 'rate_diff_ci', 'ztest_pval'}} \item{.formats}{(named \code{character} or \code{list})\cr formats for the statistics. See Details in \code{analyze_vars} for more information on the \code{"auto"} setting.}