style_pvalue: Style p-values

Description Usage Arguments Value Author(s) See Also Examples

View source: R/style_pvalue.R

Description

Style p-values

Usage

1
2
3
4
5
6
7
8
style_pvalue(
  x,
  digits = 1,
  prepend_p = FALSE,
  big.mark = NULL,
  decimal.mark = NULL,
  ...
)

Arguments

x

Numeric vector of p-values.

digits

Number of digits large p-values are rounded. Must be 1, 2, or 3. Default is 1.

prepend_p

Logical. Should 'p=' be prepended to formatted p-value. Default is FALSE

big.mark

Character used between every 3 digits to separate hundreds/thousands/millions/etc. Default is ",", except when decimal.mark = "," when the default is a space.

decimal.mark

The character to be used to indicate the numeric decimal point. Default is "." or getOption("OutDec")

...

Other arguments passed on to base::format()

Value

A character vector of styled p-values

Author(s)

Daniel D. Sjoberg

See Also

See tbl_summary vignette for examples

Other style tools: style_number(), style_percent(), style_ratio(), style_sigfig()

Examples

1
2
3
4
5
6
pvals <- c(
  1.5, 1, 0.999, 0.5, 0.25, 0.2, 0.197, 0.12, 0.10, 0.0999, 0.06,
  0.03, 0.002, 0.001, 0.00099, 0.0002, 0.00002, -1
)
style_pvalue(pvals)
style_pvalue(pvals, digits = 2, prepend_p = TRUE)

Example output

 [1] NA       ">0.9"   ">0.9"   "0.5"    "0.2"    "0.2"    "0.2"    "0.12"  
 [9] "0.10"   "0.10"   "0.060"  "0.030"  "0.002"  "0.001"  "<0.001" "<0.001"
[17] "<0.001" NA      
 [1] NA        "p>0.99"  "p>0.99"  "p=0.50"  "p=0.25"  "p=0.20"  "p=0.20" 
 [8] "p=0.12"  "p=0.10"  "p=0.10"  "p=0.060" "p=0.030" "p=0.002" "p=0.001"
[15] "p<0.001" "p<0.001" "p<0.001" NA       

gtsummary documentation built on Jan. 21, 2022, 1:09 a.m.