Repository navigation
Conversation
tmchartrand
left a comment
tmchartrand
left a comment
There was a problem hiding this comment.
I'm not quite sure about updating all the links yet, since right now we're in the phase of folks may upgrade to biodata-schema, not yet "should upgrade", and updating all links would imply "should" to me. Maybe split that out and leave as a pending PR?
|
|
||
| 1. Generate QC metrics and reference figures in the pipeline, and add the metrics to `QCEvaluation` objects. Put reference files in `results/`. | ||
| 2. Set each `QCMetric.reference` to a path relative to `results/`. For example, `results/figures/my_figure.png` should be referenced as `figures/my_figure.png`. | ||
| 3. If the input asset already has a `quality_control.json` file, load it with `QualityControl(**json.loads(your_file))` and append the new evaluations to `qc.evaluations`. Otherwise, create a new object with `QualityControl(evaluations)`. |
There was a problem hiding this comment.
do we want to instead point them to Metadata.from_metadata(... new_quality_control=QualityControl(evaluations)), or at least mention both?
| Please see the documentation on [QualityControl](https://biodata-schema.readthedocs.io/en/latest/quality_control.html) for a comprehensive overview of QC. | ||
|
|
||
| ## QC Portal | ||
| The QC Portal relies on valid metadata, particularly the fields in `data_description.json`. Validate metadata before uploading an asset; invalid or missing fields can cause the portal to display it incorrectly. |
There was a problem hiding this comment.
I would just say "validate metadata before writing it" rather than "before uploading an asset" to be more general.
|
ah but i see part of the point of this is accessing the new features in the biodata-schema docs. maybe we can add that context (upgrade optional, jointly supported for now) near the links somehow? |
Yeah I'll update that today, but yeah the point is to get people to see this QC diagram tool. Also my general view on this is that even though we're not asking people to upgrade immediately we are asking them to be aware of how things are changing and be prepared to work with us to upgrade at the next pause in data collection. Everybody is going to have to switch to the biodata registry in a year or two. |
2 participants
I moved information from the aind-qc-portal readme into the QC docs page. I also updated the biodata-schema docs to have a cool helper tool that lets you build up the default_grouping list and shows you how it will display. Should help @arjunsridhar12345 and others who have struggled with visualizing the layout in the past!
📚 Documentation preview 📚: https://scicomp-docs--240.org.readthedocs.build/en/240/