-
Notifications
You must be signed in to change notification settings - Fork 80
/
as_flextable.data.frame.Rd
73 lines (64 loc) · 1.96 KB
/
as_flextable.data.frame.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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/df_printer.R
\name{as_flextable.data.frame}
\alias{as_flextable.data.frame}
\title{Transform and summarise a 'data.frame' into a flextable
Simple summary of a data.frame as a flextable}
\usage{
\method{as_flextable}{data.frame}(
x,
max_row = 10,
split_colnames = FALSE,
short_strings = FALSE,
short_size = 35,
short_suffix = "...",
do_autofit = TRUE,
show_coltype = TRUE,
color_coltype = "#999999",
...
)
}
\arguments{
\item{x}{a data.frame}
\item{max_row}{The number of rows to print. Default to 10.}
\item{split_colnames}{Should the column names be split
(with non alpha-numeric characters). Default to FALSE.}
\item{short_strings}{Should the character column be shorten.
Default to FALSE.}
\item{short_size}{Maximum length of character column if
\code{short_strings} is TRUE. Default to 35.}
\item{short_suffix}{Suffix to add when character values are shorten.
Default to "...".}
\item{do_autofit}{Use \code{\link[=autofit]{autofit()}} before rendering the table.
Default to TRUE.}
\item{show_coltype}{Show column types.
Default to TRUE.}
\item{color_coltype}{Color to use for column types.
Default to "#999999".}
\item{...}{unused arguments}
}
\description{
It displays the first rows and shows the column types.
If there is only one row, a simplified vertical table is produced.
}
\examples{
as_flextable(mtcars)
}
\seealso{
Other as_flextable methods:
\code{\link{as_flextable}()},
\code{\link{as_flextable.gam}()},
\code{\link{as_flextable.glm}()},
\code{\link{as_flextable.grouped_data}()},
\code{\link{as_flextable.htest}()},
\code{\link{as_flextable.kmeans}()},
\code{\link{as_flextable.lm}()},
\code{\link{as_flextable.merMod}()},
\code{\link{as_flextable.pam}()},
\code{\link{as_flextable.summarizor}()},
\code{\link{as_flextable.table}()},
\code{\link{as_flextable.tabular}()},
\code{\link{as_flextable.tabulator}()},
\code{\link{as_flextable.xtable}()}
}
\concept{as_flextable methods}