-
Notifications
You must be signed in to change notification settings - Fork 114
/
modify_caption.Rd
36 lines (34 loc) · 998 Bytes
/
modify_caption.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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/modify_caption.R
\name{modify_caption}
\alias{modify_caption}
\title{Modify table caption}
\usage{
modify_caption(x, caption, text_interpret = c("md", "html"))
}
\arguments{
\item{x}{(\code{gtsummary})\cr
A gtsummary object}
\item{caption}{(\code{string})\cr
A string for the table caption/title}
\item{text_interpret}{(\code{string})\cr
String indicates whether text will be interpreted with
\code{\link[gt:md]{gt::md()}} or \code{\link[gt:html]{gt::html()}}. Must be \code{"md"} (default) or \code{"html"}.}
}
\value{
Updated gtsummary object
}
\description{
Captions are assigned based on output type.
\itemize{
\item \code{gt::gt(caption=)}
\item \code{flextable::set_caption(caption=)}
\item \code{huxtable::set_caption(value=)}
\item \code{knitr::kable(caption=)}
}
}
\examples{
trial |>
tbl_summary(by = trt, include = c(marker, stage)) |>
modify_caption(caption = "**Baseline Characteristics** N = {N}")
}