Skip to content

Commit

Permalink
Update README.md table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
spiekos authored Mar 5, 2024
1 parent 4131f21 commit 4fcca30
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions scripts/biomedical/ICTV_Taxonomy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,24 @@
## Table of Contents

1. [About the Dataset](#about-the-dataset)
1. [Download URL](#download-urls)
2. [Overview](#overview)
3. [Notes and Caveats](#notes-and-caveats)
4. [dcid Generation](#dcid-generation)
5. [License](#license)
6. [Dataset Documentation and Relevant Links](#dataset-documentation-and-relevant-links)
2. [About the Import](#about-the-import)
1. [Artifacts](#artifacts)
2. [Import Procedure](#import-procedure)
4. [Tests](#tests)
A. [Download URL](#download-urls)
B. [Overview](#overview)
C. [Notes and Caveats](#notes-and-caveats)
D. [dcid Generation](#dcid-generation)
i. [Virus](#virus)
ii. [VirusIsolate](#virusisolate)
iii. [VirusGenomeSegment](#virusgenomesegment)
iv. [Illegal Characters](#illegal-characters)
E. [License](#license)
F. [Dataset Documentation and Relevant Links](#dataset-documentation-and-relevant-links)
3. [About the Import](#about-the-import)
A. [Artifacts](#artifacts)
i. [New Schema](#new-schema)
ii. [Scripts](#scripts)
iii.[tMCFs)(#tmcfs)
iv. [Log Files](#log-files)
B. [Import Procedure](#import-procedure)
C. [Tests](#tests)


## About the Datasets
Expand Down Expand Up @@ -101,12 +109,6 @@ Classes, properties, and enumerations that were added in this import to represen
* Enumerations Generated Via Script
* VirusRealmEnum, VirusSubrealmEnum, VirusKingdomEnum, VirusSubkingdomEnum, VirusPhylumEnum, VirusSubphylumEnum, VirusClassEnum, VirusSubclassEnum, VirusOrderEnum, VirusSuborderEnum, VirusFamilyEnum, VirusSubfamilyEnum, VirusGenusEnum, VirusSubgenusEnum

#### tMCFs

- [VirusSpecies.tmcf](tMCFs/VirusSpecies.tmcf) contains the tmcf mapping to the csv of viruses.
- [VirusIsolates.tmcf](tMCFs/VirusIsolates.tmcf) contains the tmcf mapping to the csv of virus isolates.
- [VirusGenomeSegments.tmcf](tMCFs/VirusGenomeSegments.tmcf) contains the tmcf mapping to the csv of viral genome segments.

#### Scripts

##### Bash Scripts
Expand All @@ -116,10 +118,17 @@ Classes, properties, and enumerations that were added in this import to represen
- [tests.sh](scripts/tests.sh) runs standard tests on CSV + tMCF pairs to check for proper formatting.

##### Python Scripts

- [create_virus_taxonomic_ranking_enums.py](scripts/create_virus_taxonomic_ranking_enums.py) creates the viral taxonomy enum mcf file from the Virus Metadata Resource file.
- [format_virus_master_species_list.py](scripts/format_virus_master_species_list.py) parses the raw Master Species List xslx file into virus csv file.
- [format_virus_metadata_resource.py](scripts/format_virus_metadata_resource.py) parses the raw Virus Metadata Resource file into virus isolates and viral genome segements csv files.

#### tMCFs

- [VirusSpecies.tmcf](tMCFs/VirusSpecies.tmcf) contains the tmcf mapping to the csv of viruses.
- [VirusIsolates.tmcf](tMCFs/VirusIsolates.tmcf) contains the tmcf mapping to the csv of virus isolates.
- [VirusGenomeSegments.tmcf](tMCFs/VirusGenomeSegments.tmcf) contains the tmcf mapping to the csv of viral genome segments.

#### Log Files

- [format_virus_metadata_resource.log](logs/format_virus_metadata_resource.log) log file from script converting the Virus Metadata Resource into formatted CSV file.
Expand Down

0 comments on commit 4fcca30

Please sign in to comment.