-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.Rmd
More file actions
106 lines (69 loc) · 4.72 KB
/
Copy pathREADME.Rmd
File metadata and controls
106 lines (69 loc) · 4.72 KB
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
```
# `{ceplotr}`: Model agnostic plotting for cost effectiveness analysis <img src="man/figures/logo.png" align="right" alt="" width="120" />
[](https://mybinder.org/v2/gh/seabbs/ceplotr/master?urlpath=rstudio)
[](https://CRAN.R-project.org/package=ceplotr)
[](https://github.com/seabbs/ceplotr)
[](https://zenodo.org/badge/latestdoi/219757940)
[](https://cran.r-project.org/package=ceplotr)
[](https://cran.r-project.org/package=ceplotr)
**This package was outlined ahead of the HE Hackathon 2019 @Imperial. After a group discussion it was not continued in favour of aiming to improve documentation + testing for [BCEA](https://cran.r-project.org/web/packages/BCEA/index.html)**
This package aims to:
* Provide standarised modular plotting functions for cost effectiveness analysis.
* Support a single data format which is model and application agnostic.
* Provide data transformation tooling to support cost effectiveness analysis.
* Support converting model simulations, costs, etc. into this standard format.
* Provide detailed documentation of all functionality.
* Support interactive use via an interface.
* Be modular, user modfiable and extendable.
* Be fully tested, reliable and easy to use.
For help getting started see the [Getting Started](https://www.samabbott.co.uk/ceplotr/articles/intro.html) vignette.
## Installation
Install the CRAN version (when released):
```{r cran-installation, eval = FALSE}
install.packages("ceplotr")
```
Alternatively install the development version from GitHub:
```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("seabbs/ceplotr")
```
## Documentation
[](https://www.samabbott.co.uk/ceplotr/)
[](https://www.samabbott.co.uk/ceplotr/dev)
[](https://www.samabbott.co.uk/ceplotr/articles/intro.html)
[](https://www.samabbott.co.uk/ceplotr/reference/index.html)
## Testing
[](https://travis-ci.org/seabbs/ceplotr)
[](https://ci.appveyor.com/project/seabbs/ceplotr)
[](https://codecov.io/github/seabbs/ceplotr?branch=master)
## Quick start
Lets get started quickly by
See [Functions](https://www.samabbott.co.uk/ceplotr/reference/index.html) for more details of the functions used and for more package functionality.
## Shiny dashboard
```{r run-dash, eval = FALSE}
ceplotr::cd_dashboard()
```
## Contributing
File an issue [here](https://github.com/seabbs/ceplotr/issues) if there is a feature that you think is missing from the package, or better yet submit a pull request.
Please note that the `ceplotr` project is released with a [Contributor Code of Conduct](https://github.com/seabbs/ceplotr/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
## Citing
If using `ceplotr` please consider citing the package in the relevant work. Citation information can be generated in R using the following (after installing the package),
```{r}
citation("ceplotr")
```
## Docker
This package has been developed in docker based on the `rocker/tidyverse` image, to access the development environment enter the following at the command line (with an active docker daemon running),
```{bash, eval = FALSE}
docker pull seabbs/ceplotr
docker run -d -p 8787:8787 -e USER=ceplotr -e PASSWORD=ceplotr --name getTBinR seabbs/ceplotr
```
The rstudio client can be accessed on port `8787` at `localhost` (or your machines ip). The default username is ceplotr and the default password is ceplotr. Alternatively, access the development environment via [binder](https://mybinder.org/v2/gh/seabbs/ceplotr/master?urlpath=rstudio).