dataset_vignette: Output a Dataset in a Vignette in the admiral Format

Description Usage Arguments Examples

View source: R/dataset_vignette.R

Description

Output a dataset in a vignette with the pre-specified admiral format.

Usage

1
dataset_vignette(dataset, display_vars = NULL, filter = NULL)

Arguments

dataset

Dataset to output in the vignette

display_vars

Variables selected to demonstrate the outcome of the derivation

Permitted Values: list of variables

Default is NULL

If display_vars is not NULL, only the selected variables are visible in the vignette while the other variables are hidden. They can be made visible by clicking theChoose the columns to display button.

filter

Filter condition

The specified condition is applied to the dataset before it is displayed.

Permitted Values: a condition

Examples

1
2
3
4
5
6
7
8
library(admiral)
library(DT)
library(dplyr)
library(admiral.test)
data("dm")

dataset_vignette(dm)
dataset_vignette(dm, display_vars = vars(USUBJID, RFSTDTC, DTHDTC), filter = ARMCD == "Pbo")

epijim/admiral documentation built on Feb. 13, 2022, 12:15 a.m.