-
Notifications
You must be signed in to change notification settings - Fork 114
/
add_overall.Rd
110 lines (99 loc) · 2.59 KB
/
add_overall.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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/add_overall.R
\name{add_overall}
\alias{add_overall}
\alias{add_overall.tbl_summary}
\alias{add_overall.tbl_continuous}
\alias{add_overall.tbl_svysummary}
\alias{add_overall.tbl_custom_summary}
\title{Add overall column}
\usage{
add_overall(x, ...)
\method{add_overall}{tbl_summary}(
x,
last = FALSE,
col_label = "**Overall** \\nN = {style_number(N)}",
statistic = NULL,
digits = NULL,
...
)
\method{add_overall}{tbl_continuous}(
x,
last = FALSE,
col_label = "**Overall** \\nN = {style_number(N)}",
statistic = NULL,
digits = NULL,
...
)
\method{add_overall}{tbl_svysummary}(
x,
last = FALSE,
col_label = "**Overall** \\nN = {style_number(N)}",
statistic = NULL,
digits = NULL,
...
)
\method{add_overall}{tbl_custom_summary}(
x,
last = FALSE,
col_label = "**Overall** \\nN = {style_number(N)}",
statistic = NULL,
digits = NULL,
...
)
}
\arguments{
\item{x}{(\code{tbl_summary}, \code{tbl_svysummary}, \code{tbl_continuous}, \code{tbl_custom_summary})\cr
A stratified 'gtsummary' table}
\item{...}{These dots are for future extensions and must be empty.}
\item{last}{(scalar \code{logical})\cr
Logical indicator to display overall column last in table.
Default is \code{FALSE}, which will display overall column first.}
\item{col_label}{(\code{string})\cr
String indicating the column label. Default is \code{"**Overall** \\nN = {style_number(N)}"}}
\item{statistic}{(\code{\link[=syntax]{formula-list-selector}})\cr
Override the statistic argument in initial \verb{tbl_*} function
call. Default is \code{NULL}.}
\item{digits}{(\code{\link[=syntax]{formula-list-selector}})\cr
Override the digits argument in initial \verb{tbl_*} function
call. Default is \code{NULL}.}
}
\value{
A \code{gtsummary} of same class as \code{x}
}
\description{
Adds a column with overall summary statistics to tables
created by \code{tbl_summary()}, \code{tbl_svysummary()}, \code{tbl_continuous()} or
\code{tbl_custom_summary()}.
}
\examples{
# Example 1 ----------------------------------
trial |>
tbl_summary(include = c(age, grade), by = trt) |>
add_overall()
# Example 2 ----------------------------------
trial |>
tbl_summary(
include = grade,
by = trt,
percent = "row",
statistic = ~"{p}\%",
digits = ~1
) |>
add_overall(
last = TRUE,
statistic = ~"{p}\% (n={n})",
digits = ~ c(1, 0)
)
# Example 3 ----------------------------------
trial |>
tbl_continuous(
variable = age,
by = trt,
include = grade
) |>
add_overall(last = TRUE)
}
\author{
Daniel D. Sjoberg
}