Learn R Programming

⚠️There's a newer version (0.5.1) of this package.Take me there.

cards

The CDISC Analysis Results Standard aims to facilitate automation, reproducibility, reusability, and traceability of analysis results data (ARD). The {cards} package creates these CDISC Analysis Result Data Sets.

Use cases:

  1. Quality Control (QC) of existing tables and figures.

  2. Pre-calculate statistics to be summarized in tables and figures.

  3. Medical writers may easily access statistics and place in reports without copying and pasting from reports.

  4. Provides a consistent format for results and lends results to be combined across studies for re-use and re-analysis.

Installation

Install cards from CRAN with:

install.packages("cards")

You can install the development version of cards from GitHub with:

# install.packages("devtools")
devtools::install_github("insightsengineering/cards")

Extensions

The {cards} package exports three types of functions:

  1. Functions to create basic ARD objects.

  2. Utilities to create new ARD objects.

  3. Functions to work with existing ARD objects.

The {cardx} R package is an extension to {cards} that uses the utilities from {cards} and exports functions for creating additional ARD objects––including functions to summarize t-tests, Wilcoxon Rank-Sum tests, regression models, and more.

Getting Started

Review the Getting Started page for examples using ARDs to calculate statistics to later include in tables.

library(cards)

ard_continuous(ADSL, by = "ARM", variables = "AGE")
#> {cards} data frame: 24 x 10
#>    group1 group1_level variable stat_name stat_label   stat
#> 1     ARM      Placebo      AGE         N          N     86
#> 2     ARM      Placebo      AGE      mean       Mean 75.209
#> 3     ARM      Placebo      AGE        sd         SD   8.59
#> 4     ARM      Placebo      AGE    median     Median     76
#> 5     ARM      Placebo      AGE       p25         Q1     69
#> 6     ARM      Placebo      AGE       p75         Q3     82
#> 7     ARM      Placebo      AGE       min        Min     52
#> 8     ARM      Placebo      AGE       max        Max     89
#> 9     ARM    Xanomeli…      AGE         N          N     84
#> 10    ARM    Xanomeli…      AGE      mean       Mean 74.381
#> ℹ 14 more rows
#> ℹ Use `print(n = ...)` to see more rows
#> ℹ 4 more variables: context, fmt_fn, warning, error

Other Resources

Copy Link

Version

Install

install.packages('cards')

Monthly Downloads

45,836

Version

0.3.0

License

Apache License 2.0

Issues

Pull Requests

Stars

Forks

Maintainer

Daniel D. Sjoberg

Last Published

October 3rd, 2024

Functions in cards (0.3.0)

ard_stack_hierarchical

Stacked Hierarchical ARD Statistics
ard_hierarchical

Hierarchical ARD Statistics
.calculate_stats_as_ard

Calculate Continuous Statistics
ard_stack

Stack ARDs
ard_missing

Missing ARD Statistics
.default_fmt_fn

Add Default Formatting Functions
.detect_msgs

Detect Columns with Non-Null Contents
ard_total_n

ARD Total N
ard_attributes

ARD Attributes
ard_categorical

Categorical ARD Statistics
as_card

Data Frame as ARD
.is_named_list

Named List Predicate
.lst_results_as_df

Prepare Results as Data Frame
.calculate_tabulation_statistics

Calculate Tabulation Statistics
as_nested_list

ARD as Nested List
ard_strata

Stratified ARD
bind_ard

Bind ARDs
.check_var_nms

Check Variable Names
get_ard_statistics

ARD Statistics as List
.cli_condition_messaging

Print Condition Messages Saved in an ARD
.nesting_rename_ard_columns

Rename ARD Columns
.fill_overall_grp_values

Fill Overall Group Variables
maximum_variable_value

Maximum Value
mock

Mock ARDs
check_pkg_installed

Check Package Installation
.check_dichotomous_value

Perform Value Checks
.pair_columns

Pair columns
.is_list_column_of_scalars

List Column as a Vector Predicate
.process_denominator

Process denominator Argument
selectors

ARD Selectors
.fill_grps_from_variables

Back Fill Group Variables
.check_fmt_string

Check 'xx' Format Structure
.eval_ard_calls

Evaluate the ard_*() function calls
cards-package

cards: Analysis Results Data
default_stat_labels

Defaults for Statistical Arguments
.unique_and_sorted

ARD-flavor of unique()
label_cards

Generate Formatting Function
eval_capture_conditions

Evaluate and Capture Conditions
.cli_groups_and_variable

Locate Condition Messages in an ARD
.one_row_ard_to_nested_list

Convert One Row to Nested List
.create_list_for_attributes

Create List for Attributes
.rename_last_group_as_variable

Rename Last Group to Variable
.shift_column_pair

Shift column pair
reexports

Objects exported from other packages
.process_nested_list_as_df

Convert Nested Lists to Column
.purrr_list_flatten

A list_flatten()-like Function
summary_functions

Summary Functions
syntax

Selecting Syntax
replace_null_statistic

Replace NULL Statistics with Specified Value
shuffle_ard

Shuffle ARD
round5

Rounding of Numbers
print_ard_conditions

Print ARD Condition Messages
.check_for_missing_combos_in_denom

Check for Missing Levels in denominator
check_ard_structure

Check ARD Structure
process_selectors

Process tidyselectors
.check_no_ard_columns

Check Protected Column Names
.table_as_df

Results from table() as Data Frame
rename_ard_columns

Rename ARD Columns
.trim_ard

Trim ARD
update_ard

Update ARDs
nest_for_ard

ARD Nesting
print.card

Print
tidy_ard_order

Standard Order of ARD
tidy_as_ard

Build ARD from Tidier
alias_as_fmt_fn

Convert Alias to Function
apply_fmt_fn

Apply Formatting Functions
ard_dichotomous

Dichotomous ARD Statistics
add_calculated_row

Add Calculated Row
adam

Example ADaM Data
ard_complex

Complex ARD Summaries
ard_continuous

Continuous ARD Statistics