-
Notifications
You must be signed in to change notification settings - Fork 20
/
fetch_sequences.smk
328 lines (297 loc) · 11.3 KB
/
fetch_sequences.smk
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
"""
This part of the workflow handles fetching sequences and metadata from GISAID
or NCBI GenBank/Biosample. Depends on the main Snakefile to define the variable
`database`, which is NOT a wildcard.
If the config contains `s3_dst`,`s3_src`, and `fetch_from_database=False`,
then files will be fetched from the AWS S3 bucket. Or else, the data is fetched
directly from the databases.
Produces different final outputs for GISAID vs GenBank/RKI:
GISAID:
ndjson = "data/gisaid.ndjson"
GenBank:
ndjson = "data/genbank.ndjson"
biosample = "data/biosample.ndjson"
cog_uk_accessions = "data/cog_uk_accessions.tsv"
cog_uk_metadata = "data/cog_uk_metadata.csv.gz"
rki_ndjson = "data/rki.ndjson"
"""
rule fetch_main_gisaid_ndjson:
output:
ndjson = temp(f"data/gisaid.ndjson")
benchmark:
"benchmarks/fetch_main_gisaid_ndjson.txt"
retries: 5
shell:
"""
./bin/fetch-from-gisaid {output.ndjson}
"""
rule fetch_ncbi_dataset_package:
output:
dataset_package = temp("data/ncbi_dataset.zip")
retries: 5
benchmark:
"benchmarks/fetch_ncbi_dataset_package.txt"
shell:
"""
datasets download virus genome taxon SARS-CoV-2 \
--no-progressbar \
--include "genome,biosample" \
--filename {output.dataset_package}
"""
rule extract_ncbi_dataset_sequences:
input:
dataset_package = "data/ncbi_dataset.zip"
output:
ncbi_dataset_sequences = temp("data/ncbi_dataset_sequences.fasta")
benchmark:
"benchmarks/extract_ncbi_dataset_sequences.txt"
shell:
"""
unzip -jp {input.dataset_package} \
ncbi_dataset/data/genomic.fna > {output.ncbi_dataset_sequences}
"""
def _get_ncbi_dataset_field_mnemonics(wildcard):
"""
Return list of NCBI Dataset report field mnemonics for fields that we want
to parse out of the dataset report. The column names in the output TSV
are different from the mnemonics.
See NCBI Dataset docs for full list of available fields and their column
names in the output:
https://www.ncbi.nlm.nih.gov/datasets/docs/v2/reference-docs/command-line/dataformat/tsv/dataformat_tsv_virus-genome/#fields
"""
fields = [
"accession",
"sourcedb",
"sra-accs",
"isolate-lineage",
"geo-region",
"geo-location",
"isolate-collection-date",
"release-date",
"update-date",
"virus-pangolin",
"length",
"host-name",
"isolate-lineage-source",
"biosample-acc",
"submitter-names",
"submitter-affiliation",
"submitter-country",
]
return ",".join(fields)
rule format_ncbi_dataset_report:
input:
dataset_package = "data/ncbi_dataset.zip"
output:
ncbi_dataset_tsv = temp("data/ncbi_dataset_report.tsv")
params:
fields_to_include = _get_ncbi_dataset_field_mnemonics
benchmark:
"benchmarks/format_ncbi_dataset_report.txt"
shell:
"""
dataformat tsv virus-genome \
--package {input.dataset_package} \
--fields {params.fields_to_include} \
> {output.ncbi_dataset_tsv}
"""
rule create_genbank_ndjson:
input:
ncbi_dataset_sequences = "data/ncbi_dataset_sequences.fasta",
ncbi_dataset_tsv = "data/ncbi_dataset_report.tsv",
output:
ndjson = temp("data/genbank.ndjson"),
log: "logs/create_genbank_ndjson.txt"
benchmark:
"benchmarks/create_genbank_ndjson.txt"
shell:
"""
augur curate passthru \
--metadata {input.ncbi_dataset_tsv} \
--fasta {input.ncbi_dataset_sequences} \
--seq-id-column Accession \
--seq-field sequence \
--unmatched-reporting warn \
--duplicate-reporting warn \
2> {log} > {output.ndjson}
"""
rule extract_ncbi_dataset_biosample:
input:
dataset_package = "data/ncbi_dataset.zip"
output:
biosample = temp("data/biosample.ndjson")
benchmark:
"benchmarks/extract_ncbi_dataset_biosample.txt"
shell:
"""
unzip -jp {input.dataset_package} \
ncbi_dataset/data/biosample_report.jsonl > {output.biosample}
"""
rule fetch_cog_uk_accessions:
"""Fetching COG-UK sample accesions (GenBank only)"""
output:
cog_uk_accessions = temp("data/cog_uk_accessions.tsv")
benchmark:
"benchmarks/fetch_cog_uk_accessions.txt"
retries: 5
shell:
"""
./bin/fetch-from-cog-uk-accessions > {output.cog_uk_accessions}
"""
rule fetch_cog_uk_metadata:
"""Fetching COG-UK metadata (GenBank only)"""
output:
cog_uk_metadata = temp("data/cog_uk_metadata.csv.gz")
benchmark:
"benchmarks/fetch_cog_uk_metadata.txt"
retries: 5
shell:
"""
./bin/fetch-from-cog-uk-metadata > {output.cog_uk_metadata}
"""
rule uncompress_cog_uk_metadata:
input:
"data/cog_uk_metadata.csv.gz"
output:
cog_uk_metadata = temp("data/cog_uk_metadata.csv")
benchmark:
"benchmarks/uncompress_cog_uk_metadata.txt"
shell:
"gunzip -c {input} > {output}"
rule fetch_rki_sequences:
output:
rki_sequences=temp("data/rki_sequences.fasta.xz"),
benchmark:
"benchmarks/fetch_rki_sequences.txt"
retries: 5
shell:
"""
./bin/fetch-from-rki-sequences > {output.rki_sequences}
"""
rule fetch_rki_metadata:
output:
rki_metadata=temp("data/rki_metadata.tsv.xz"),
benchmark:
"benchmarks/fetch_rki_metadata.txt"
retries: 5
shell:
"""
./bin/fetch-from-rki-metadata > {output.rki_metadata}
"""
rule transform_rki_data_to_ndjson:
input:
rki_sequences="data/rki_sequences.fasta.xz",
rki_metadata="data/rki_metadata.tsv.xz"
output:
ndjson="data/rki.ndjson",
benchmark:
"benchmarks/transform_rki_data_to_ndjson.txt"
shell:
"""
./bin/transform-rki-data-to-ndjson \
--input-rki-sequences {input.rki_sequences} \
--input-rki-metadata {input.rki_metadata} \
--output-ndjson {output.ndjson}
"""
# Only include rules to fetch from S3 if S3 config params are provided
if config.get("s3_dst") and config.get("s3_src"):
# Set ruleorder since these fetch rules have the same output
# Fetch directly from databases when `fetch_from_database=True`
# or else fetch files from AWS S3 buckets
if config.get("fetch_from_database", False):
ruleorder: fetch_main_gisaid_ndjson > fetch_main_ndjson_from_s3
ruleorder: extract_ncbi_dataset_biosample > fetch_biosample_from_s3
ruleorder: transform_rki_data_to_ndjson > fetch_rki_ndjson_from_s3
ruleorder: fetch_cog_uk_accessions > fetch_cog_uk_accessions_from_s3
ruleorder: fetch_cog_uk_metadata > compress_cog_uk_metadata
ruleorder: uncompress_cog_uk_metadata > fetch_cog_uk_metadata_from_s3
ruleorder: create_genbank_ndjson > fetch_main_ndjson_from_s3
else:
ruleorder: fetch_rki_ndjson_from_s3 > transform_rki_data_to_ndjson
ruleorder: fetch_main_ndjson_from_s3 > fetch_main_gisaid_ndjson
ruleorder: fetch_biosample_from_s3 > extract_ncbi_dataset_biosample
ruleorder: fetch_cog_uk_accessions_from_s3 > fetch_cog_uk_accessions
ruleorder: fetch_cog_uk_metadata_from_s3 > uncompress_cog_uk_metadata
ruleorder: compress_cog_uk_metadata > fetch_cog_uk_metadata
ruleorder: fetch_main_ndjson_from_s3 > create_genbank_ndjson
rule fetch_main_ndjson_from_s3:
"""Fetching main NDJSON from AWS S3"""
params:
file_on_s3_dst=f"{config['s3_dst']}/{database}.ndjson.zst",
file_on_s3_src=f"{config['s3_src']}/{database}.ndjson.zst",
lines = config.get("subsample",{}).get("main_ndjson", 0)
output:
ndjson = temp(f"data/{database}.ndjson")
benchmark:
"benchmarks/fetch_main_ndjson_from_s3.txt"
shell:
"""
./vendored/download-from-s3 {params.file_on_s3_dst} {output.ndjson} {params.lines} || \
./vendored/download-from-s3 {params.file_on_s3_src} {output.ndjson} {params.lines}
"""
rule fetch_biosample_from_s3:
"""Fetching BioSample NDJSON from AWS S3"""
params:
file_on_s3_dst=f"{config['s3_dst']}/biosample.ndjson.zst",
file_on_s3_src=f"{config['s3_src']}/biosample.ndjson.zst",
lines = config.get("subsample",{}).get("biosample", 0)
output:
biosample = temp("data/biosample.ndjson")
benchmark:
"benchmarks/fetch_biosample_from_s3.txt"
shell:
"""
./vendored/download-from-s3 {params.file_on_s3_dst} {output.biosample} {params.lines} || \
./vendored/download-from-s3 {params.file_on_s3_src} {output.biosample} {params.lines}
"""
rule fetch_rki_ndjson_from_s3:
params:
file_on_s3_dst=f"{config['s3_dst']}/rki.ndjson.zst",
file_on_s3_src=f"{config['s3_src']}/rki.ndjson.zst",
lines = config.get("subsample",{}).get("rki_ndjson", 0)
output:
rki_ndjson = temp("data/rki.ndjson")
benchmark:
"benchmarks/fetch_rki_ndjson_from_s3.txt"
shell:
"""
./vendored/download-from-s3 {params.file_on_s3_dst} {output.rki_ndjson} {params.lines} || \
./vendored/download-from-s3 {params.file_on_s3_src} {output.rki_ndjson} {params.lines}
"""
rule fetch_cog_uk_accessions_from_s3:
params:
file_on_s3_dst=f"{config['s3_dst']}/cog_uk_accessions.tsv.zst",
file_on_s3_src=f"{config['s3_src']}/cog_uk_accessions.tsv.zst",
lines = config.get("subsample",{}).get("cog_uk_accessions", 0)
output:
biosample = "data/cog_uk_accessions.tsv" if config.get("keep_temp",False) else temp("data/cog_uk_accessions.tsv")
benchmark:
"benchmarks/fetch_cog_uk_accessions_from_s3.txt"
shell:
"""
./vendored/download-from-s3 {params.file_on_s3_dst} {output.biosample} {params.lines} || \
./vendored/download-from-s3 {params.file_on_s3_src} {output.biosample} {params.lines}
"""
rule fetch_cog_uk_metadata_from_s3:
params:
file_on_s3_dst=f"{config['s3_dst']}/cog_uk_metadata.csv.zst",
file_on_s3_src=f"{config['s3_src']}/cog_uk_metadata.csv.zst",
lines = config.get("subsample",{}).get("cog_uk_metadata", 0)
output:
biosample = temp("data/cog_uk_metadata.csv")
benchmark:
"benchmarks/fetch_cog_uk_metadata_from_s3.txt"
shell:
"""
./vendored/download-from-s3 {params.file_on_s3_dst} {output.biosample} {params.lines} || \
./vendored/download-from-s3 {params.file_on_s3_src} {output.biosample} {params.lines}
"""
rule compress_cog_uk_metadata:
input:
"data/cog_uk_metadata.csv"
output:
cog_uk_metadata = "data/cog_uk_metadata.csv.gz" if config.get("keep_temp",False) else temp("data/cog_uk_metadata.csv.gz")
benchmark:
"benchmarks/compress_cog_uk_metadata.txt"
shell:
"gzip -c {input} > {output}"