-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
75 lines (49 loc) · 2.92 KB
/
README.Rmd
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# cards <a href="https://insightsengineering.github.io/cards/"><img src="man/figures/logo.png" align="right" height="120" alt="cards website" /></a>
<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/cards)](https://CRAN.R-project.org/package=cards)
[![R-CMD-check](https://github.com/insightsengineering/cards/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/insightsengineering/cards/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/insightsengineering/cards/branch/main/graph/badge.svg)](https://app.codecov.io/gh/insightsengineering/cards?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->
The [CDISC Analysis Results Standard](https://www.cdisc.org/standards/foundational/analysis-results-standard) aims to facilitate automation, reproducibility, reusability, and traceability of analysis results data (ARD).
The {cards} package creates these **C**DISC **A**nalysis **R**esult **D**ata **S**ets.
Use cases:
1. Quality Control (QC) of existing tables and figures.
1. Pre-calculate statistics to be summarized in tables and figures.
1. Medical writers may easily access statistics and place in reports without copying and pasting from reports.
1. 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:
```r
install.packages("cards")
```
You can install the development version of cards from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("insightsengineering/cards")
```
## Extensions
[![cardx website](https://raw.githubusercontent.com/insightsengineering/cardx/main/man/figures/logo.png){style="float: right" width="120"}](https://insightsengineering.github.io/cardx/)
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}](https://github.com/insightsengineering/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](https://insightsengineering.github.io/cards//main/articles/getting-started.html) page for examples using ARDs to calculate statistics to later include in tables.
```{r}
library(cards)
ard_continuous(ADSL, by = "ARM", variables = "AGE")
```