-
Notifications
You must be signed in to change notification settings - Fork 114
/
style_pvalue.Rd
55 lines (50 loc) · 1.35 KB
/
style_pvalue.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/style_pvalue.R
\name{style_pvalue}
\alias{style_pvalue}
\title{Style p-values}
\usage{
style_pvalue(
x,
digits = 1,
prepend_p = FALSE,
big.mark = ifelse(decimal.mark == ",", " ", ","),
decimal.mark = getOption("OutDec"),
...
)
}
\arguments{
\item{x}{(\code{numeric})\cr
Numeric vector of p-values.}
\item{digits}{(\code{integer})\cr
Number of digits large p-values are rounded. Must be 1, 2, or 3.
Default is 1.}
\item{prepend_p}{(scalar \code{logical})\cr
Logical. Should 'p=' be prepended to formatted p-value.
Default is \code{FALSE}}
\item{big.mark}{(\code{string})\cr
Character used between every 3 digits to separate
hundreds/thousands/millions/etc.
Default is \code{","}, except when \code{decimal.mark = ","} when the default is a space.}
\item{decimal.mark}{(\code{string})\cr
The character to be used to indicate the numeric decimal point.
Default is \code{"."} or \code{getOption("OutDec")}}
\item{...}{Arguments passed on to \code{base::format()}}
}
\value{
A character vector of styled p-values
}
\description{
Style p-values
}
\examples{
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)
}
\author{
Daniel D. Sjoberg
}