From 10fc30b5d67cde717f3822bfb31f0938b04ba2f0 Mon Sep 17 00:00:00 2001 From: Pradeep Bashyal Date: Mon, 13 Oct 2025 18:15:22 -0500 Subject: [PATCH 1/3] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d7180b..5133f50 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # hfx -HFX (Haplotype Frequecy eXchange) Format Specification +HFX (Haplotype Frequency eXchange) Format Specification + +[hfx.schema.json](hfx.schema.json) is [JSON Schema](https://json-schema.org/) for publishing Haplotype Frequency in HFX format. \ No newline at end of file From 2ded058dc82ff0aae861ed9cbbf4f8745c4f6c00 Mon Sep 17 00:00:00 2001 From: Pradeep Bashyal Date: Wed, 22 Oct 2025 11:09:27 -0500 Subject: [PATCH 2/3] change 'group' description. --- hfx.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hfx.schema.json b/hfx.schema.json index b9dc3ff..1ae606b 100644 --- a/hfx.schema.json +++ b/hfx.schema.json @@ -270,7 +270,7 @@ }, "group": { "type": "string", - "description": "Groups such as NHP, DLA, FISH etc.." + "description": "Groups identified on the https://www.ebi.ac.uk/ipd/mhc/ and https://www.ebi.ac.uk/ipd/nhkir/ web pages." }, "version": { "type": "string", From d880d5c1bf2519081e904cb07c51bf10a8fe066b Mon Sep 17 00:00:00 2001 From: Pradeep Bashyal Date: Mon, 27 Oct 2025 13:27:16 -0500 Subject: [PATCH 3/3] - Remove `group` from `nomenclature` in schema - Fix `frequencyDataLocation` inconsistency --- .gitignore | 7 +++++++ examples/csv-frequency/cau.hfx-metadata.json | 3 +-- examples/inline-frequency/cau.hfx-metadata.json | 3 +-- hfx.schema.json | 10 +++------- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index e69de29..8bc945c 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1,7 @@ +.DS_Store + +.venv +venv + +.idea + diff --git a/examples/csv-frequency/cau.hfx-metadata.json b/examples/csv-frequency/cau.hfx-metadata.json index 5c3aa94..c5e67c2 100644 --- a/examples/csv-frequency/cau.hfx-metadata.json +++ b/examples/csv-frequency/cau.hfx-metadata.json @@ -48,7 +48,6 @@ }, "nomenclatureUsed": { "database": "IPD-IMGT/HLA", - "group": "", "version": "3.20.0" }, "producer": { @@ -60,7 +59,7 @@ "year": "2007" } }, - "frequencyLocation": "file://cau.csv", + "frequencyDataLocation": "file://cau.csv", "checkSum": "8e7bb58cff1a32c250898c13f2c354f4" } } diff --git a/examples/inline-frequency/cau.hfx-metadata.json b/examples/inline-frequency/cau.hfx-metadata.json index 2a2907c..2018fe8 100644 --- a/examples/inline-frequency/cau.hfx-metadata.json +++ b/examples/inline-frequency/cau.hfx-metadata.json @@ -48,7 +48,6 @@ }, "nomenclatureUsed": { "database": "IPD-IMGT/HLA", - "group": "", "version": "3.20.0" }, "producer": { @@ -60,7 +59,7 @@ "year": "2007" } }, - "frequencyLocation": "inline" + "frequencyDataLocation": "inline" }, "frequencyData": [ { diff --git a/hfx.schema.json b/hfx.schema.json index 1ae606b..963ced3 100644 --- a/hfx.schema.json +++ b/hfx.schema.json @@ -35,7 +35,7 @@ "producer": { "$ref": "#/$defs/producer" }, - "frequencyLocation": { + "frequencyDataLocation": { "$ref": "#/$defs/frequencyDataLocation" }, "license": { @@ -52,7 +52,7 @@ "hfeMethod", "cohortDescription", "nomenclatureUsed", - "frequencyLocation" + "frequencyDataLocation" ], "additionalProperties": false }, @@ -163,7 +163,7 @@ "properties": { "species": { "type": "string", - "description": "The species the Hf set is based on" + "description": "Species as defined in https://www.ebi.ac.uk/ena/ i.e. https://www.ebi.ac.uk/ena/browser/view/Taxon:9606 for 'human'" }, "population": { "type": "array", @@ -268,10 +268,6 @@ ], "description": "IPD main groups" }, - "group": { - "type": "string", - "description": "Groups identified on the https://www.ebi.ac.uk/ipd/mhc/ and https://www.ebi.ac.uk/ipd/nhkir/ web pages." - }, "version": { "type": "string", "description": "Version of the IPD database"