Skip to content

Commit

Permalink
Update hub schemas (#26)
Browse files Browse the repository at this point in the history
* update gitignore

* update hub config

* fix metadata schema
  • Loading branch information
sbidari authored Nov 6, 2024
1 parent 7e87866 commit 1cc31b6
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 18 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
*.Rproj

/renv/
/test/

model-metadata/README_files/
model-output/README_files/
Expand Down
2 changes: 1 addition & 1 deletion hub-config/admin.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"schema_version": "https://raw.githubusercontent.com/hubverse-org/schemas/main/v3.0.0/admin-schema.json",
"name": "COVID-19 Forecast Hub",
"maintainer": "CDC",
"maintainer": "US CDC",
"contact": {
"name": "Subekshya Bidari",
"email": "covidhub@cdc.gov"
Expand Down
21 changes: 9 additions & 12 deletions hub-config/model-metadata-schema.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Schema for Modeling Hub model metadata",
"description": "This is the schema for model metadata files, please refer to https://github.com/covid19-forecast-hub-europe/covid19-forecast-hub-europe/wiki/Metadata for more information.",
"description": "This is the schema for model metadata files, please refer to https://github.com/CDCgov/covid19-forecast-hub/blob/main/model-metadata/README.md for more information.",
"type": "object",
"properties": {
"team_name": {
Expand Down Expand Up @@ -39,16 +39,17 @@
"affiliation": {
"type": "string"
},
"orcid": {
"type": "string",
"pattern": "^\\d{4}\\-\\d{4}\\-\\d{4}\\-[\\dX]{4}$"
},
"email": {
"type": "string",
"format": "email"
},
"additionalProperties": false
}
"orcid": {
"type": "string",
"pattern": "^\\d{4}\\-\\d{4}\\-\\d{4}\\-[\\dX]{4}$"
}
},
"additionalProperties": false,
"required": ["name", "affiliation", "email"]
}
},
"website_url": {
Expand Down Expand Up @@ -108,13 +109,9 @@
"ensemble_of_hub_models": {
"description": "Indicator for whether this model is an ensemble of other models submitted to this Hub",
"type": "boolean"
},
"source_notes": {
"description": "Original source of the model output data",
"type": "string"
}
},
"additionalProperties": true,
"additionalProperties": false,
"required": [
"team_name",
"team_abbr",
Expand Down
8 changes: 3 additions & 5 deletions hub-config/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"task_ids": {
"reference_date": {
"required": null,
"optional": ["2024-11-09", "2024-11-16", "2024-11-23",
"optional": ["2024-11-16", "2024-11-23",
"2024-11-30", "2024-12-07", "2024-12-14", "2024-12-21",
"2024-12-28", "2025-01-04", "2025-01-11", "2025-01-18",
"2025-01-25", "2025-02-01", "2025-02-08", "2025-02-15",
Expand Down Expand Up @@ -84,7 +84,7 @@
},
"target_end_date": {
"required": null,
"optional": ["2024-11-09", "2024-11-16", "2024-11-23",
"optional": ["2024-11-16", "2024-11-23",
"2024-11-30", "2024-12-07", "2024-12-14", "2024-12-21",
"2024-12-28", "2025-01-04", "2025-01-11", "2025-01-18",
"2025-01-25", "2025-02-01", "2025-02-08", "2025-02-15",
Expand Down Expand Up @@ -150,9 +150,7 @@
"target_name": "incident covid hospitalizations",
"target_units": "count",
"target_keys": {
"target": [
"wk inc covid hosp"
]
"target": "wk inc covid hosp"
},
"target_type": "continuous",
"description": "This target represents the count of new hospitalizations in the week ending on the date [horizon] weeks after the reference_date, on the target_end_date.",
Expand Down

0 comments on commit 1cc31b6

Please sign in to comment.