-
Notifications
You must be signed in to change notification settings - Fork 10
/
README.Rmd
65 lines (51 loc) · 3.37 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
---
output: github_document
---
<!-- markdownlint-disable-file -->
<!-- README.md is generated from README.Rmd. Please edit that file -->
# `crmPack`
<!-- badges: start -->
[](https://CRAN.R-project.org/package=crmPack)
[](https://www.repostatus.org/#active)
[](https://opensource.org/license/apache-2-0)
[](https://github.com/openpharma/crmPack/actions/workflows/check.yaml)
[](https://raw.githubusercontent.com/openpharma/crmPack/_xml_coverage_reports/data/main/badge.svg)
<!-- badges: end -->
<p align="center"> <img src='man/figures/logo.png' align="right" height="131.5" alt="crmPack-logo"/> </p>
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
The goal of `crmPack` is to implement a wide range of model-based dose
escalation designs, ranging from classical and modern continual
reassessment methods (CRMs) based on dose-limiting toxicity endpoints to
dual-endpoint designs taking into account a biomarker/efficacy outcome. The
focus is on Bayesian inference, making it very easy to setup a new design
with your own JAGS code. However, it is also possible to implement 3+3
designs for comparison or models with non-Bayesian estimation. The whole
package is written in a modular form in the S4 class system, making it very
flexible for adaptation to new models, escalation or stopping rules.
## Installation
You can install the development version of `crmPack` from GitHub with:
```{r gh-installation, eval = FALSE}
devtools::install_github("openpharma/crmPack")
```
You can install the stable release version of `crmPack` from CRAN with:
```{r cran-installation, eval = FALSE}
install.packages("crmPack")
```
## Examples
The package vignettes provide information on various aspects of CRM trial design, implementation, simulation and analysis:
* [Trial definition](https://openpharma.github.io/crmPack/main/articles/trial_definition.html)
* [Trial analysis](https://openpharma.github.io/crmPack/main/articles/trial_analysis.html)
* [Sanity checking](https://openpharma.github.io/crmPack/main/articles/trial_sanity_checks.html)
* [Simulation of operating characteristics](https://openpharma.github.io/crmPack/main/articles/trial_simulation.html)
* [Ordinal CRM models](https://openpharma.github.io/crmPack/main/articles/ordinal-crm.html)
* [Extending `crmPack`](https://openpharma.github.io/crmPack/main/articles/parallel_computing_with_extensions.html)
* [Tidy `crmPack` data](https://openpharma.github.io/crmPack/main/articles/tidy_method.html)
* [Describing `crmPack` objects in Markdown and Quarto documents](https://openpharma.github.io/crmPack/main/articles/knit_print.html)
* [Migration from the old crmPack](https://openpharma.github.io/crmPack/main/articles/migration_from_the_old_crmPack.html)
* Sabanes Bove et al (2019) Model-based Dose Escalation Designs in R with `crmPack`. JSS 89:10 [DOI 10.18637/jss.v089.i10](https://www.jstatsoft.org/article/view/v089i10)