Skip to content

Commit

Permalink
Remove NCBI Virus API related files
Browse files Browse the repository at this point in the history
Due to #18, the NCBI Virus
API is more of a hassle to use. The data from NCBI Datasets CLI covers
the standard fields that we use in pathogen ingests, so we can drop
the use of the undocumented NCBI Virus API.

If any pathogen needs additional custom fields that are not available
through NCBI Datasets, the pipeline can use fetch-from-ncbi-entrez
and parse the GenBank file.
  • Loading branch information
joverlee521 committed Sep 14, 2023
1 parent c97df23 commit 6a76d0b
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 469 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,9 @@ Scripts for supporting ingest workflow automation that don’t really belong in
NCBI interaction scripts that are useful for fetching public metadata and sequences.

- [fetch-from-ncbi-entrez](fetch-from-ncbi-entrez) - Fetch metadata and nucleotide sequences from [NCBI Entrez](https://www.ncbi.nlm.nih.gov/books/NBK25501/) and output to a GenBank file.
Useful for pathogens with metadata and annotations in custom fields that are not part of the standard [NCBI Virus](https://www.ncbi.nlm.nih.gov/labs/virus/vssi/) or [NCBI Datasets](https://www.ncbi.nlm.nih.gov/datasets/) outputs.
- [fetch-from-ncbi-virus](fetch-from-ncbi-virus) - Fetch metadata and nucleotide sequences from [NCBI Virus](https://www.ncbi.nlm.nih.gov/labs/virus/vssi/#/) and output NDJSON records to stdout.
- [ncbi-virus-url](ncbi-virus-url) - Generates the URL to download metadata and sequences from NCBI Virus as a single CSV file.
- [csv-to-ndjson](csv-to-ndjson) - Converts CSV file to NDJSON file with a hard-coded 200MiB field size limit to accommodate sequences in the NCBI Virus download.
Useful for pathogens with metadata and annotations in custom fields that are not part of the standard [NCBI Datasets](https://www.ncbi.nlm.nih.gov/datasets/) outputs.

Historically, some pathogen repos used the undocumented NCBI Virus API through [fetch-from-ncbi-virus](https://github.com/nextstrain/ingest/blob/c97df238518171c2b1574bec0349a55855d1e7a7/fetch-from-ncbi-virus) to fetch data. However we've opted to drop the NCBI Virus scripts due to https://github.com/nextstrain/ingest/issues/18.

Potential Nextstrain CLI scripts

Expand Down
15 changes: 0 additions & 15 deletions csv-to-ndjson

This file was deleted.

292 changes: 0 additions & 292 deletions docs/ncbi-virus-all-fields-example.json

This file was deleted.

33 changes: 0 additions & 33 deletions fetch-from-ncbi-virus

This file was deleted.

Loading

0 comments on commit 6a76d0b

Please sign in to comment.