loinc / comp-loinc

Computational LOINC in OWL.
MIT License
13 stars 4 forks source link

Docs: Update for project setup & way of doing it #62

Closed joeflack4 closed 2 months ago

joeflack4 commented 4 months ago

Overview

These docs in the README.md are out of date:

Required LOINC Files: For now, these files are [downloadable from GoogleDrive](https://drive.google.com/drive/u/0/folders/1SjDFYs1ocbpovGlAZDKuRVcTDoNztHOc).
   They need to be put in these locations:
- `data/part_files/ComponentTree.tsv`
- `data/code_files/LOINC.csv`
- `data/code_files/LoincPartlink_Primary.csv`

Questions

  1. I downloaded the LOINC release. It contains LoincPartlink_Primary.csv. It also contains LOINC.csv (albeit not capitalized). But it doesn't contain ComponentTree.tsv. Is this file perhaps a rename of ComponentHierarchyBySystem.csv?

Sub-issues

2. Change how we do the setup

I think it would be better to do this setup via a make command that utilizes the download link to the latest LOINC release. I think that previously we were relying on the LOINC team to give us some custom artefacts, but I think that Shahim has since refactored the codebase to just use the LOINC release.

I would propose that we just have the make goal download the loinc_release into data.

I also propose that we just reference the files by their names in the release, and expect them to be where they are in that directory, rather than renaming / moving them around. But this may require changes to our codebase, so alternatively we could also have the make goal move/rename these files for us.