Skip to content

Commit 931c311

Browse files
MichaelClerxchonlei
authored andcommitted
Update README.md
1 parent a94d07c commit 931c311

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

Diff for: README.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ A detailed mathematical modelling of voltage-clamp experiment.
44
This repo contains all data and code for reproducing the results in the paper "*Accounting for variability in ion current recordings using a mathematical model of artefacts in voltage-clamp experiments*" by Chon Lok Lei, Michael Clerx, Dominic Whittaker, David Gavaghan, Teun de Boer, and Gary Mirams.
55

66

7-
### Prerequisite
7+
### Installing
8+
9+
To run the code to generate the data and figures shown in the paper, please follow these steps first:
810

911
1. Clone [hERGRapidCharacterisation](https://github.com/CardiacModelling/hERGRapidCharacterisation) to the relative path `../hERGRapidCharacterisation`.
1012
2. To setup, either run (for Linux/macOS users)
@@ -18,29 +20,29 @@ install [PINTS](https://github.com/pints-team/pints) and [Myokit](http://myokit.
1820
### Results
1921

2022
#### Section 3: Validating the mathematical model with electrical model cell experiments
21-
[model-cell-experiments](./model-cell-experiments): Application of the voltage-clamp experiment model to electrical model cell experiments.
2223

23-
It contains results and code to reproduce Figures 4, 5; Table 2; Figures S4, S5; Tables S1, S2.
24+
- [model-cell-experiments](./model-cell-experiments): Application of the voltage-clamp experiment model to electrical model cell experiments.
25+
- contains results and code to reproduce Figures 4, 5; Table 2; Figures S4, S5; Tables S1, S2.
2426

2527
#### Section 4: Application to variability in CHO-hERG1a patch-clamp data
26-
[herg-syn-study](./herg-syn-study): Synthetic studies with the voltage-clamp experiment model.
2728

28-
It contains results and code to reproduce Figure S6.
29+
- [herg-syn-study](./herg-syn-study): Synthetic studies with the voltage-clamp experiment model.
30+
- contains results and code to reproduce Figure S6.
2931

30-
[herg-real-data](./herg-real-data): Application of the voltage-clamp experiment model to data in [hERGRapidCharacterisation](https://github.com/CardiacModelling/hERGRapidCharacterisation).
32+
- [herg-real-data](./herg-real-data): Application of the voltage-clamp experiment model to data in [hERGRapidCharacterisation](https://github.com/CardiacModelling/hERGRapidCharacterisation).
3133

32-
It contains results and code to reproduce Hypothesis 2: Figures 7, 8; Figures S7, S8, S9; Tables S3, S4.
33-
It also contains results and code that are mentioned but not shown in the paper: full voltage-clamp experiment model fitting to hERG data; independent kinetics with independent artefacts 'Hypothesis 3'.
34+
- Contains results and code to reproduce Hypothesis 2: Figures 7, 8; Figures S7, S8, S9; Tables S3, S4.
35+
- Also contains results and code that are mentioned but not shown in the paper: full voltage-clamp experiment model fitting to hERG data; independent kinetics with independent artefacts 'Hypothesis 3'.
3436

3537
### Supporting files
3638

37-
[lib](./lib): Contains all modules/utility functions.
39+
- [lib](./lib): Contains all modules/utility functions.
3840

39-
[mmt-model-files](./mmt-model-files): [Myokit](http://myokit.org/) model files, contains IKr model and voltage clamp experiment model etc.
41+
- [mmt-model-files](./mmt-model-files): [Myokit](http://myokit.org/) model files, contains IKr model and voltage clamp experiment model etc.
4042

41-
[protocol-time-series](./protocol-time-series): Contains protocols as time series, stored as `.csv` files, with time points (in `s`) and voltage (in `mV`)
43+
- [protocol-time-series](./protocol-time-series): Contains protocols as time series, stored as `.csv` files, with time points (in `s`) and voltage (in `mV`)
4244

43-
`data`, `data-autoLC`, `manualselection`, `qc`: symbolic links to [hERGRapidCharacterisation](https://github.com/CardiacModelling/hERGRapidCharacterisation)
45+
- `data`, `data-autoLC`, `manualselection`, `qc`: symbolic links to [hERGRapidCharacterisation](https://github.com/CardiacModelling/hERGRapidCharacterisation)
4446

4547

4648
## Acknowledging this work

0 commit comments

Comments
 (0)