cmu-delphi/delphi-epidata

metadata generation improvements

Open

#990 opened on Oct 4, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (67 forks)auto 404
acquisitionapi changeenhancementhelp wanted

Repository metrics

Stars
 (104 stars)
PR merge metrics
 (PR metrics pending)

Description

  • metadata generation routine can get the list of src/sig faster now by using just the signal dimension TABLE and not the big complicated VIEW to gather them
  • add sort_keys=True to json.dumps() to ensure deterministic output
  • add number of points to metadata for each aggregation since we are in there already... and maybe avg number of re-issues to metadata if we wanna also hit the full table

https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/acquisition/covidcast/database.py#L494

Contributor guide

Research direction
Modify metadata generation by: (1) replacing the complex VIEW with the simpler signal dimension TABLE for faster source/signal listing, (2) adding `sort keys=True` to `json.dumps()` for deterministic output, and (3) adding point count and average re issue count to metadata. Refer to the linked code section in `src/acquisition/covidcast/database.py`. Test the changes to ensure correctness.
Tech stack
python
Domain
backenddata
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSQL
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75