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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/formatters.R
\name{colformat_num}
\alias{colformat_num}
\title{format numeric cells}
\usage{
colformat_num(
x,
i = NULL,
j = NULL,
big.mark = get_flextable_defaults()$big.mark,
decimal.mark = get_flextable_defaults()$decimal.mark,
na_str = get_flextable_defaults()$na_str,
nan_str = get_flextable_defaults()$nan_str,
prefix = "",
suffix = "",
...
)
}
\arguments{
\item{x}{a flextable object}
\item{i}{rows selection}
\item{j}{columns selection.}
\item{big.mark, decimal.mark}{see \code{\link[=format]{format()}}}
\item{na_str, nan_str}{string to be used for NA and NaN values}
\item{prefix, suffix}{string to be used as prefix or suffix}
\item{...}{additional argument for function \code{\link[=format]{format()}}, \code{scientific}
and \code{digits} can not be used.}
}
\description{
Format numeric cells in a flextable.
The function is different from \code{\link[=colformat_double]{colformat_double()}} on numeric type
columns. The function uses the \code{\link[=format]{format()}} function of R on numeric
type columns. So this is normally what you see on the R console
most of the time (but scientific mode is disabled and NA are replaced).
}
\section{format call}{
Function \code{\link[=format]{format()}} is called with the following values:
\itemize{
\item \code{trim} is set to TRUE,
\item \code{scientific} is set to FALSE,
\item \code{big.mark} is set to the value of \code{big.mark} argument,
\item \code{decimal.mark} is set to the value of \code{decimal.mark} argument,
\item other arguments are passed 'as is' to the format function.
}
argument \code{digits} is ignored as it is not the same \code{digits} that users
want, this one will be used by \code{\link[=format]{format()}} and not \code{\link[=formatC]{formatC()}}.
To change the digit argument use \code{options(digits=4)} instead.
This argument will not be changed because \code{colformat_num()}
is supposed to format things roughly as what you see on the R console.
If these functions does not fit your needs, use \code{\link[=set_formatter]{set_formatter()}}
that lets you use any format function.
}
\section{Illustrations}{
\if{html}{\figure{fig_colformat_num_1.png}{options: width="400"}}
}
\examples{
dat <- mtcars
dat[2,1] <- NA
ft <- flextable(head(dat))
ft <- colformat_num(x = ft,
big.mark=" ", decimal.mark = ",",
na_str = "N/A")
ft <- autofit(ft)
ft
}
\seealso{
Other cells formatters:
\code{\link{colformat_char}()},
\code{\link{colformat_datetime}()},
\code{\link{colformat_date}()},
\code{\link{colformat_double}()},
\code{\link{colformat_image}()},
\code{\link{colformat_int}()},
\code{\link{colformat_lgl}()},
\code{\link{set_formatter}()}
}
\concept{cells formatters}
|
