This function allows to initialize a flow chart given any database. It will create a fc object showing the number of rows of the database. If a database is not available, the user can instead directly enter the number of rows in the study.
Usage
as_fc(
.data = NULL,
N = NULL,
label = "Initial dataframe",
text_pattern = "{label}\n{N}",
just = "center",
text_color = "black",
text_fs = 8,
text_fface = 1,
text_ffamily = NA,
text_padding = 1,
bg_fill = "white",
border_color = "black",
hide = FALSE
)Arguments
- .data
Data frame to be initialised as a flowchart.
- N
Number of rows of the study in case `.data` is NULL.
- label
Character with the text that will be shown in the box.
- text_pattern
Structure that will have the text in the box. It recognizes label, n, N and perc within brackets. For default it is "{label}\n{N}".
- just
Justification for the text: left, center or right. Default is center.
- text_color
Color of the text. It is black by default. See the `col` parameter for
gpar.- text_fs
Font size of the text. It is 8 by default. See the `fontsize` parameter for
gpar.- text_fface
Font face of the text. It is 1 by default. See the `fontface` parameter for
gpar.- text_ffamily
Changes the font family of the text. Default is NA. See the `fontfamily` parameter for
gpar.- text_padding
Changes the text padding inside the box. Default is 1. This number has to be greater than 0.
- bg_fill
Box background color. It is white by default. See the `fill` parameter for
gpar.- border_color
Box border color. It is black by default. See the `col` parameter for
gpar.- hide
Logical value to hide the initial box or not. Default is FALSE. hide = TRUE can only be combined with fc_split().
Examples
safo |>
as_fc(label = "Patients assessed for eligibility") |>
fc_draw()
