df: The variables specified by vars, arm_var, and saffl_var.
alt_counts_df (if specified): USUBJID and the variables specified by arm_var and saffl_var.
Argument
Description
Default
df
(data.frame) Dataset (typically ADSL) required to build table.
No default
alt_counts_df
(character) Alternative dataset used only to calculate column counts.
NULL
arm_var
(character) Arm variable used to split table into columns.
"ARM"
saffl_var
(character) Flag variable used to indicate inclusion in safety population.
"SAFFL"
id_var
(character) Identifier variable used to count the participants within each flag.
"USUBJID"
trtsdtm_var
(character) Treatment start datetime variable in df.
"TRTSDTM"
trtedtm_var
(character) Treatment end datetime variable in df.
"TRTEDTM"
u_trtdur
(character) Unit for duration of treatment. Options are "days", "weeks", "months" and "years".
"days"
lbl_trtdur
(character) Label for treatment duration variable u_trtdur.
paste("Duration of Treatment,", u_trtdur)
lbl_overall
(character) If specified, an overall column will be added to the table with the given value as the column label.
NULL
risk_diff
(named list) List of settings to apply to add a risk difference column to the table. See tern::add_riskdiff() for more details. List should contain the following elements:
arm_x: (required) the name of reference arm.
arm_y: (required) the name of the arm to compare to the reference arm.
col_label: (optional) label to use for the risk difference column. Defaults to "Risk Difference (%) (95% CI)".
pct: (optional) whether the output should be returned as percentages. Defaults to TRUE.
NULL
prune_0
(flag) Whether all-zero rows should be removed from the table.
TRUE
annotations
(named list of character) List of annotations to add to the table. Valid annotation types are title, subtitles, main_footer, and prov_footer. Each name-value pair should use the annotation type as name and the desired string as value.
---title: FDA Table 5subtitle: Duration of Treatment Exposure, Safety Population, Pooled Analysesformat: html---::: panel-tabset## Spec. Screenshot![](../assets/images/screenshots/table_05.png){fig-align="center"}## rtables Table```{r tbl, message=FALSE, warning=FALSE}# Load Libraries & Datalibrary(cardinal)adsl <- random.cdisc.data::cadsl# Output Tablerisk_diff <- list(arm_x = "B: Placebo", arm_y = "A: Drug X") # optionalmake_table_05(df = adsl, risk_diff = risk_diff)```## rtables Table Setup```{r tbl, eval=FALSE, echo=TRUE}```## Function Details### `make_table_05()`------------------------------------------------------------------------Required variables:- **`df`**: The variables specified by `vars`, `arm_var`, and `saffl_var`.- **`alt_counts_df`** (if specified): `USUBJID` and the variables specified by `arm_var` and `saffl_var`.+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| **Argument** | **Description** | **Default** |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `df` | (`data.frame`) Dataset (typically ADSL) required to build table. | *No default* |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `alt_counts_df` | (`character`) Alternative dataset used only to calculate column counts. | `NULL` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `arm_var` | (`character`) Arm variable used to split table into columns. | `"ARM"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `saffl_var` | (`character`) Flag variable used to indicate inclusion in safety population. | `"SAFFL"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `id_var` | (`character`) Identifier variable used to count the participants within each flag. | `"USUBJID"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `trtsdtm_var` | (`character`) Treatment start datetime variable in df. | `"TRTSDTM"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `trtedtm_var` | (`character`) Treatment end datetime variable in df. | `"TRTEDTM"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `u_trtdur` | (`character`) Unit for duration of treatment. Options are `"days"`, `"weeks"`, `"months"` and `"years"`. | `"days"` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `lbl_trtdur` | (`character`) Label for treatment duration variable `u_trtdur`. | `paste("Duration of Treatment,", u_trtdur)` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `lbl_overall` | (`character`) If specified, an overall column will be added to the table with the given value as the column label. | `NULL` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `risk_diff` | (named `list`) List of settings to apply to add a risk difference column to the table. See [`tern::add_riskdiff()`](https://insightsengineering.github.io/tern/main/reference/add_riskdiff.html) for more details. List should contain the following elements: | `NULL` || | | || | - `arm_x`: (required) the name of reference arm. | || | | || | - `arm_y`: (required) the name of the arm to compare to the reference arm. | || | | || | - `col_label`: (optional) label to use for the risk difference column. Defaults to `"Risk Difference (%) (95% CI)"`. | || | | || | - `pct`: (optional) whether the output should be returned as percentages. Defaults to `TRUE`. | |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `prune_0` | (`flag`) Whether all-zero rows should be removed from the table. | `TRUE` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+| `annotations` | (named `list` of `character`) List of annotations to add to the table. Valid annotation types are `title`, `subtitles`, `main_footer`, and `prov_footer.` Each name-value pair should use the annotation type as name and the desired string as value. | `NULL` |+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------+Source code for this function is available [here](https://github.com/pharmaverse/cardinal/blob/main/R/fda-table_05.R).:::