Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding a "record type" field #239

Closed
afrubin opened this issue Jul 13, 2024 · 1 comment · Fixed by #345 or #362
Closed

Adding a "record type" field #239

afrubin opened this issue Jul 13, 2024 · 1 comment · Fixed by #345 or #362
Assignees
Labels
app: backend Task implementation touches the backend type: enhancement Enhancement to an existing feature

Comments

@afrubin
Copy link
Member

afrubin commented Jul 13, 2024

We can differentiate between records from score sets, experiments, etc. by looking at what fields are included, but this is imperfect and makes some tasks (like choosing what view models to use for validation in MaveTools) harder.

I propose adding a new field to the view models called type or recordType or similar that identifies what view model was used to create it. This could get extended to label meta-analysis score sets or other possibly-forthcoming record types, like records describing clinical annotations/strength of evidence or base editor data, that might have slightly different fields or validation constraints.

The benefit is that it makes validation of uploads and downstream processing of records much more explicit. The downside is that we have to figure out exactly what labels go in the field, and it also makes the API output slightly more verbose.

@bencap bencap added the type: enhancement Enhancement to an existing feature label Aug 27, 2024
@bencap bencap added the app: backend Task implementation touches the backend label Oct 1, 2024
@bencap
Copy link
Collaborator

bencap commented Oct 7, 2024

Consider just adding some sort of pydantic extension to the view model base class that does this automatically.

@bencap bencap linked a pull request Oct 23, 2024 that will close this issue
@bencap bencap self-assigned this Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app: backend Task implementation touches the backend type: enhancement Enhancement to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants