-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
74 lines (53 loc) · 3.85 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
---
output: github_document
always_allow_html: true
---
<!-- Add badges here -->
[![Check Package
📦](https://github.com/hta-pharma/ramnog/actions/workflows/Check-package.yaml/badge.svg)](https://github.com/hta-pharma/ramnog/actions/workflows/Check-package.yaml)
[![Release Package
🚀](https://github.com/hta-pharma/ramnog/actions/workflows/Release-package.yaml/badge.svg)](https://github.com/hta-pharma/ramnog/actions/workflows/Release-package.yaml)
[![codecov.io](https://img.shields.io/codecov/c/gh/hta-pharma/ramnog?style=plastic&label=codecov.io)]((https://app.codecov.io/github/hta-pharma/ramnog?branch=main))
<!-- Until here -->
# ramnog <a href="https://hta-pharma.github.io/ramnog/"><img src="man/figures/logo.png" align="right" height="138" alt="ramnog website" /></a>
# R packages for AMNOG analyses <a href="https://hta-pharma.github.io/ramnog/"><img src="man/figures/logo.png" align="right" height="138" alt="ramnog website" /></a>
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
Ramnog is a collection of packages for setting up pipelines for AMNOG-style HTA analyses
The aim of ramnog is that statistician/programmer can set up an AMNOG-type analyses with minimal familiarity with R.
To get started, check out the [Quick Start](articles/ramnog.html) guide
# Packages
```{r, echo=FALSE}
library(kableExtra)
library(data.table)
dt <- data.table::data.table(
Package = c("[chef](https://hta-pharma.github.io/chef/)", "[chefStats](https://hta-pharma.github.io/chefStats/)", "[chefCriteria](https://hta-pharma.github.io/chefCriteria/)", "[ramnog]((https://hta-pharma.github.io/ramnog/))"),
Description = c(
"Core package that aids in creating endpoint specifications, builds the analysis pipeline, and coordinates the execution of the ananlyses",
"Collection of statistical methods that are used to make summarizations or inferences for each endpoint/outcome",
"Collection of criteria that are used in AMNOG dossiers to determin when specific analyses/statistics should be calculated",
"Wrapper package tying ecosystem together"
)
)
dt |>
kable(format = "html", table.attr = "class='table table-bordered'") |>
kable_styling(bootstrap_options = c("hover", "condensed", "responsive")) |>
row_spec(0, background = "#2C3E50", color = "white")
```
# Aim
The aim of {ramnog} is that a programmer has to write minimal code, and no programming, to set-up a new AMNOG-type analyses.
For each study, the programmer will need to make, adjust, or check the following four types of code:
1. The definition of each endpoint (or group of endpoints).
2. A set of ADaM functions that makes any modifications to existing ADaM datasets (e.g., new age grouping in ADSL), or makes new ADaM datasets if none exist for the required output.
3. (If needed) Define a set of criteria for when an endpoint should be included in the results. A library of these criteria are stored in the companion package {[chefCriteria](https://hta-pharma.github.io/chefCriteria/)}.
4. A specification of the statistical functions used to summarize/analyze the data. A library of these functions are provided in the {[chefStats](https://hta-pharma.github.io/chefStats/)} package.
A core principal of the frameworks design is __modularity__.
The core functionality of the framework resides in {[chef](https://hta-pharma.github.io/chef/)} and should change slowly, while functionality that is subject to more frequent changes are sectioned off in other packages ({[chefStats](https://hta-pharma.github.io/chefStats/)} and {[chefCriteria](https://hta-pharma.github.io/chefCriteria/)}).
# Contributing
We welcome contributions to the code base. Please see the [contributing vignette](articles/dev_contribute.html) for more information on how to contribute.
# Installation
The packages are available to install from GitHub:
```{r, eval=FALSE}
remotes::install_github("hta-pharma/ramnog")
```