Skip to contents

Functions to tidy <summarised_result>

tidy(<summarised_result>) experimental
Turn a <summarised_result> object into a tidy tibble

Split functions

splitAdditional()
Split additional_name and additional_level columns
splitAll()
Split all pairs name-level into columns.
splitGroup()
Split group_name and group_level columns
splitStrata()
Split strata_name and strata_level columns

Add settings and estimates

addSettings()
Add settings columns to a <summarised_result> object
pivotEstimates()
Set estimates as columns

Table functions

Main functions

visOmopTable()
Format a <summarised_result> object into a gt, flextable, or tibble object
visTable() experimental
Generate a formatted table from a <data.table>

Additional table formating functions

formatEstimateName()
Formats estimate_name and estimate_value column
formatEstimateValue()
Formats the estimate_value column
formatHeader()
Create a header for gt and flextable objects
formatTable()
Creates a flextable or gt object from a dataframe

Helper table functions

tableOptions()
Additional table formatting options for visOmopTable() and visTable()
tableStyle()
Supported predefined styles for formatted tables
tableType()
Supported table classes

Plot functions

barPlot() experimental
Create a bar plot visualisation from a <summarised_result> object
boxPlot() experimental
Create a box plot visualisation from a <summarised_result> object
scatterPlot() experimental
Create a scatter plot visualisation from a <summarised_result> object

Filter functions

filterAdditional()
Filter the additional_name-additional_level pair in a summarised_result
filterGroup()
Filter the group_name-group_level pair in a summarised_result
filterSettings()
Filter a <summarised_result> using the settings
filterStrata()
Filter the strata_name-strata_level pair in a summarised_result

Other functionalities

Column retrieval functions

additionalColumns()
Identify variables in additional_name column
groupColumns()
Identify variables in group_name column
settingsColumns()
Identify settings columns of a <summarised_result>
strataColumns()
Identify variables in strata_name column
tidyColumns()
Identify tidy columns of a <summarised_result>

Unite functions

uniteAdditional()
Unite one or more columns in additional_name-additional_level format
uniteGroup()
Unite one or more columns in group_name-group_level format
uniteStrata()
Unite one or more columns in strata_name-strata_level format

Mock

mockSummarisedResult()
A <summarised_result> object filled with mock data

Deprecated

fxTable() deprecated
Creates a flextable object from a dataframe
gtTable() deprecated
Creates a gt object from a dataframe
optionsVisOmopTable() deprecated
Additional table formatting options
splitNameLevel() deprecated
Split name and level columns into the columns
uniteNameLevel() deprecated
Unite one or more columns in name-level format