Skip to content

Commit 997d57f

Browse files
authored
Update lollipop.md (#95)
Added an example on how to run Covvfit for regular operations.
1 parent 1d02780 commit 997d57f

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

docs/running_deconv/lollipop.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,44 @@ lollipop deconvolute $ldata/tallymut.tsv \
8585
--n-cores=2
8686
```
8787

88-
## Run *CovvFit*
88+
# Run *CovvFit*
8989

90-
You are ready to use *Covvfit* and can proceed to the tutorial [here](../cli.md).
90+
If you followed the installation guide [here](../installation.md), you are ready to use *Covvfit*. You can have a look at the tutorial [here](../cli.md).
91+
92+
## Prepare parameters
93+
In the example below, we are looking at tracking the variants KP.2, KP.3, XEC, LP.8, NB.1.8.1 and XFG. We will prepare a config yaml before running:
94+
95+
```bash
96+
cat << EOF > covvfit_config.yaml
97+
variants:
98+
- KP.2
99+
- KP.3
100+
- XEC
101+
- LP.8
102+
- NB.1.8.1
103+
- XFG
104+
plot:
105+
dimensions:
106+
right: 1.2
107+
time_spacing: 3
108+
variant_colors:
109+
JN.1: '#00E9FF'
110+
KP.2: '#7A5B58'
111+
KP.3: '#3A38F3'
112+
XEC: '#6C3072'
113+
LP.8: '#379E33'
114+
NB.1.8.1: '#BDC94D'
115+
XFG: '#9E7A29'
116+
undetermined: '#969696'
117+
EOF
118+
```
119+
120+
## Run *CovvFit* on *LolliPop* output
121+
122+
Run on the last 365 days of data, and provide a 90 days horizon forecast.
123+
124+
```bash
125+
covvfit infer -i deconvolved.csv -o output -c covvfit_config.yaml --max-days 365 --horizon 90
126+
```
127+
128+
After running we can find the results in the _output_ folder, including the figures together with the _pairwise_fitnesses.csv_.

0 commit comments

Comments
 (0)