Skip to content

Commit 8ab73ff

Browse files
committed
Add description of GISAID issues for context dataset
1 parent d14f2f4 commit 8ab73ff

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

config/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,21 @@ by editing [targets.yaml](/config/targets.yaml) or via the command line:
100100
snakemake --config CONTEXT_FASTA="path/to/fasta"
101101
```
102102

103+
> [!IMPORTANT]
104+
> The GISAID EpiCoV database is proprietary and not openly accessible. For details, refer
105+
> to the [GISAID Terms of Use](https://gisaid.org/terms-of-use/).
106+
> VIPERA uses [GISAIDR](https://github.com/Wytamma/GISAIDR) to automate access to GISAID data.
107+
> However, this access can be unstable or occasionally fail due to changes in the platform.
108+
> Possible workarounds are documented in the GISAIDR repository (e.g. issues
109+
> [#55](https://github.com/Wytamma/GISAIDR/issues/55) and [#58](https://github.com/Wytamma/GISAIDR/issues/58)).
110+
> If programmatic access fails, a suitable context dataset must be manually provided by setting the
111+
> `CONTEXT_FASTA` parameter to the path of a FASTA file.
112+
> As a last resort, some of the analyses can be allowed to run even if context-dependent rules
113+
> fail by passing the `--keep-going` flag to Snakemake.
114+
> To replicate [our work](https://doi.org/10.1093/ve/veae018), the automatic context dataset is available via
115+
> DOI: [10.55876/gis8.250718er](https://doi.org/10.55876/gis8.250718er) (EPI_SET_250718er).
116+
> Read more about EPI_SETs [here](https://gisaid.org/episet/).
117+
103118
## Mapping reference sequence
104119

105120
Setting `MAPPING_REFERENCES_FASTA` to `null` (default) will enable the automatic download of the

0 commit comments

Comments
 (0)