tbl_pint: Point and interval (pint)

Description Usage Arguments Value Examples

View source: R/tbl_pint.R

Description

Point and interval (pint)

Usage

1
2
3
4
5
6
7
8
9
tbl_pint(
  estimate,
  lower,
  upper,
  bracket_left = "(",
  bracket_right = ")",
  bracket_sep = ", ",
  ...
)

Arguments

estimate

point estimate values

lower

lower values of interval estimate

upper

upper values of interval estimate

bracket_left

character value that will close the interval on the left

bracket_right

character value that will close the interval on the right

bracket_sep

character value that will separate the lower and upper interval estimates

...

Arguments passed on to tbl_string

.sep

Separator used to separate elements

.envir

environment to evaluate each expression in.

round_half_to_even

a logical value. If TRUE, then when the fractional part of x is half-way between two rounding boundaries, it will be rounded to the even boundary nearest to x. For example, +23.5 becomes +24, as does +24.5; while −23.5 becomes −24, as does −24.5. If FALSE, halves are automatically rounded to the boundary with highest absolute value.

breaks

a positive, monotonically increasing numeric vector designating rounding boundaries. With breaks = c(1, 10, 100, 1000) and decimals = c(2, 1, 0)

decimals

a numeric vector of equal length to breaks that indicates how many decimals to round to in the numeric range designated by breaks. (see notes for example). Allowed values are 0 <= decimals <= 20.

miss_replace

a character string that replaces missing values.

big_mark

a character value used to separate number groups to the left of the decimal point. See prettyNum for more details on this. Set this input to ” to negate it's effect.

big_interval

a numeric value indicating the size of number groups for numbers before (hence big) the decimal.

small_mark

a character value used to separate number groups to the right of the decimal point.

small_interval

a numeric value indicating the size of number groups for numbers after (hence small) the decimal.

decimal_mark

the character to be used to indicate the numeric decimal point.

zero_print

a logical value, character string or NULL value specifying if and how zeros should be formatted specially. Useful for pretty printing 'sparse' objects.

trim

a logical value; if FALSE, logical, numeric and complex values are right-justified to a common width: if TRUE the leading blanks for justification are suppressed.

Value

a character vector of length equal to the estimate vector.

Examples

1
tbl_pint(1.12, 1.00, 1.25)

bcjaeger/tblStrings documentation built on Aug. 17, 2020, 9:36 a.m.