Skip to content
Snippets Groups Projects
Commit c354db6f authored by Rob Moss's avatar Rob Moss
Browse files

Simplify the installation instructions

The spleenrbc package can now be installed from my personal R-universe
package registry (see https://robmoss.r-universe.dev/builds).
parent d766b140
Branches
No related tags found
No related merge requests found
......@@ -10,39 +10,24 @@ See the [online documentation](https://rgmoss.pages.gitlab.unimelb.edu.au/malari
The model is implemented [in R](https://www.r-project.org/) and provided as an R package called `spleenrbc`.
The simplest way to install this package is:
1. Clone this repository:
```sh
git clone https://gitlab.unimelb.edu.au/rgmoss/malaria-spleen-rbc-loss.git
```
2. Launch R:
```sh
R
```
3. Use [devtools](https://devtools.r-lib.org/) to install the model package:
```R
# Install devtools if it isn't already installed.
install.packages("devtools")
# Install the spleenrbc package.
devtools::install("malaria-spleen-rbc-loss")
```
```R
install.packages("spleenrbc", repos = "https://robmoss.r-universe.dev")
library(spleenrbc)
```
You will then be able to run the baseline model scenarios, and define and run your own model scenarios.
See the provided [package documentation and vignettes](https://rgmoss.pages.gitlab.unimelb.edu.au/malaria-spleen-rbc-loss/) for examples.
4. Load the `spleenrbc` package as per usual:
## Running simulations and plotting results
```R
library(spleenrbc)
```
The simulation and plotting scripts are not included in the package itself.
In order to run them, you will need to clone this repository:
You will then be able to run the provided simulation and plotting scripts (see below).
You can also define and run your own model scenarios.
See the provided package documentation and vignettes for examples (see below).
```sh
git clone https://gitlab.unimelb.edu.au/rgmoss/malaria-spleen-rbc-loss.git
cd malaria-spleen-rbc-loss
```
## Running simulations
### Running simulations
There are scripts to run the following simulations:
......@@ -56,7 +41,7 @@ There are scripts to run the following simulations:
Both sets of simulations use Latin hypercube sampling (LHS) and vary 18 of the baseline parameters by +/- 20%.
Note that this may take **around 2 hours** to complete.
## Plotting results
### Plotting results
Each simulation script saves the results to a separate CSV file in the `outputs/` directory.
......@@ -67,7 +52,7 @@ For example, run the following command to plot the baseline Pf results:
./plot-scenarios.R outputs/baseline-pf.csv
```
## Sensitivity analyses
### Sensitivity analyses
Summaries of each sensitivity analysis are provided as `.rds` files in the `outputs/` directory.
Summary plots for each sensitivity analysis can be produced by running:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment