format_measure: Format measure

Description Usage Arguments Value

View source: R/utils.R

Description

This helper takes the output from a twoxtwo effect measure function and formats the point estimate and lower/upper bounds of the computed confidence interval (CI) as a string.

Usage

1
format_measure(.data, digits = 3)

Arguments

.data

Output from a twoxtwo effect measure function (e.g. odds_ratio)

digits

Number of digits; default is 3

Value

A character vector of length 1 with the effect measure formatted as point estimate (lower bound of CI, upper bound of CI). The point estimate and CI are rounded to precision specified in "digits" argument.


vpnagraj/twoxtwo documentation built on Nov. 3, 2021, 6:20 p.m.