-
Notifications
You must be signed in to change notification settings - Fork 114
/
tbl_butcher.Rd
48 lines (45 loc) · 1.41 KB
/
tbl_butcher.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/tbl_butcher.R
\name{tbl_butcher}
\alias{tbl_butcher}
\title{Butcher table}
\usage{
tbl_butcher(x, include = c("table_body", "table_styling"))
}
\arguments{
\item{x}{(\code{gtsummary})\cr
a gtsummary object}
\item{include}{(\code{character})\cr
names of additional elements to retain in the gtsummary
object. \code{c("table_body", "table_styling")} will always be retained.}
}
\value{
a gtsummary object
}
\description{
Some gtsummary objects can become large and the size becomes cumbersome
when working with the object.
The function removes all elements from a gtsummary object, except those
required to print the table. This may result in gtsummary functions
that add information or modify the table, such as \code{add_global_p()},
will no longer execute
after the excess elements have been removed (aka butchered). Of note,
the majority of \code{inline_text()} calls will continue to execute
properly.
}
\examples{
\dontshow{if (identical(Sys.getenv("NOT_CRAN"), "true") || identical(Sys.getenv("IN_PKGDOWN"), "true")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
tbl_large <-
trial |>
tbl_uvregression(
y = age,
method = lm
)
tbl_butchered <-
tbl_large |>
tbl_butcher()
# size comparison
object.size(tbl_large) |> format(units = "Mb")
object.size(tbl_butchered)|> format(units = "Mb")
\dontshow{\}) # examplesIf}
}