Function reference • Tplyr

Build

High-level functions to create and build a table

build(): Trigger the execution of the tplyr_table

tplyr_table(): Create a Tplyr table object

pop_data() `pop_data<-`() set_pop_data(): Return or set population data bindings

pop_treat_var() set_pop_treat_var(): Return or set pop_treat_var binding

Layers and layering

Creating layers and adding them to the table

add_layer() add_layers(): Attach a layer to a tplyr_table object

tplyr_layer(): Create a tplyr_layer object

group_count() group_desc() group_shift(): Create a count, desc, or shift layer for discrete count based summaries, descriptive statistics summaries, or shift count summaries

Formatting

Customizing the display as a table

f_str(): Create a f_str object

get_desc_layer_formats() set_desc_layer_formats() get_count_layer_formats() set_count_layer_formats() get_shift_layer_formats() set_shift_layer_formats(): Get or set the default format strings for descriptive statistics layers

set_format_strings(): Set the format strings and associated summaries to be performed in a layer

set_missing_count(): Set the display for missing strings

Sorting

Sorting and customizing table order

set_order_count_method() set_ordering_cols() set_result_order_var(): Set the ordering logic for the count layer

set_outer_sort_position(): Set the value of a outer nested count layer to Inf or -Inf

Adding Groups and Stats

Adding treatment groups, total rows, and risk difference

add_total_row(): Add a Total row into a count summary.

add_treat_grps() add_total_group() treat_grps(): Combine existing treatment groups for summary

add_risk_diff(): Add risk difference to a count layer

add_missing_subjects_row(): Add a missing subject row into a count summary.

set_total_row_label(): Set the label for the total row

set_missing_subjects_row_label(): Set the label for the missing subjects row

Descriptive Statistics Layer Functions

Descriptive statistics layer helper functions

set_custom_summaries(): Set custom summaries to be performed within a descriptive statistics layer

set_precision_data(): Set precision data

get_precision_by() set_precision_by(): Set or return precision_by layer binding

get_precision_on() set_precision_on(): Set or return precision_on layer binding

set_stats_as_columns(): Set descriptive statistics as columns

Counting functions

Count layer helper functions

set_denoms_by(): Set variables used in pct denominator calculation

set_distinct_by(): Set counts to be distinct by some grouping variable.

set_denom_where(): Set Logic for denominator subsetting

set_nest_count(): Set the option to nest count layers

set_outer_sort_position(): Set the value of a outer nested count layer to Inf or -Inf

set_missing_count(): Set the display for missing strings

keep_levels(): Select levels to keep in a count layer

set_denom_ignore(): Set values the denominator calculation will ignore

set_indentation(): Set the option to prefix the row_labels in the inner count_layer

set_numeric_threshold(): Set a numeric cutoff

set_limit_data_by(): Set variables to limit reported data values only to those that exist rather than fully completing all possible levels

Column Headers

Column header helpers

add_column_headers(): Attach column headers to a Tplyr output

header_n() `header_n<-`() set_header_n(): Return or set header_n binding

Metadata Functions

Tplyr metadata functions

tplyr_meta(): Tplyr Metadata Object

add_variables() add_filters(): Add variables to a tplyr_meta object

add_anti_join(): Add an anti-join onto a tplyr_meta object

get_metadata(): Get the metadata dataframe from a tplyr_table

append_metadata(): Append the Tplyr table metadata dataframe

get_meta_result(): Extract the result metadata of a Tplyr table

get_meta_subset(): Extract the subset of data based on result metadata

Templates

Layer Templates

new_layer_template() remove_layer_template() get_layer_template() get_layer_templates() use_template(): Create, view, extract, remove, and use Tplyr layer templates

Post-pocessing

Post-pocessing functions

apply_conditional_format(): Conditional reformatting of a pre-populated string of numbers

apply_formats(): Apply Format Strings outside of a Tplyr table

apply_row_masks(): Replace repeating row label variables with blanks in preparation for display.

collapse_row_labels(): Collapse row labels into a single column

replace_leading_whitespace(): Reformat strings with leading whitespace for HTML

str_extract_fmt_group() str_extract_num(): Extract format group strings or numbers

str_indent_wrap(): Wrap strings to a specific width with hyphenation while preserving indentation

Helper functions

General helper functions

get_numeric_data(): Retrieve the numeric data from a tplyr objects

get_stats_data(): Get statistics data

get_by() set_by(): Set or return by layer binding

get_target_var() set_target_var(): Set or return treat_var binding

treat_var() set_treat_var(): Return or set the treatment variable binding

get_where() set_where() set_pop_where() get_pop_where(): Set or return where binding for layer or table

Tplyr Tplyr-package: A grammar of summary data for clinical reports

get_tplyr_regex(): Retrieve one of Tplyr's regular expressions

Data

Tplyr Built-in Datasets

tplyr_adae: ADAE Data

tplyr_adas: ADAS Data

tplyr_adlb: ADLB Data

tplyr_adsl: ADSL Data

tplyr_adpe: ADPE Data

get_data_labels(): Get Data Labels