Skip to content

[ENH] Remove the static HTML QC pages#329

Merged
DESm1th merged 13 commits intoTIGRLab:masterfrom
DESm1th:remove_static_pg
Jun 9, 2022
Merged

[ENH] Remove the static HTML QC pages#329
DESm1th merged 13 commits intoTIGRLab:masterfrom
DESm1th:remove_static_pg

Conversation

@DESm1th
Copy link
Copy Markdown
Contributor

@DESm1th DESm1th commented Mar 28, 2022

This pull request will get rid of the old static qc pages and instead generates json 'manifest' files that tell the dashboard how to display everything. This will make it easier to drop in new metrics in the future, since they can be generated by any script as long as the outputs land in the qc directory and contain these simple json sidecars.

  • Adds a 'Metric' class to provide a uniform interface for QC metric generation code, and sub-classes for each of our existing QC metrics 18a25a0, 77b19fe
  • Updates how resources folders are read from datman.scan.Scan 1b6527d, 3f31550
  • Moves the find_tech_notes function to datman.utils and updates dm_xnat_extract so it stores tech notes paths in the database d85d5d3, 527f9ce
  • Updates dm_qc_report to remove all code that wrote html and instead use the datman.metrics classes to generate metrics 30b9149

@auto-assign auto-assign bot requested review from benselby, jerdra and josephmje March 28, 2022 20:07
@pep8speaks
Copy link
Copy Markdown

pep8speaks commented Mar 28, 2022

Hello @DESm1th, Thank you for updating!

Cheers! There are no style issues detected in this Pull Request. 🍻 To test for issues locally, pip install flake8 and then run flake8 datman.

Comment last updated at 2022-06-09 17:25:14 UTC

@DESm1th DESm1th requested a review from edickie March 28, 2022 20:08
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 28, 2022

Codecov Report

Merging #329 (27a2946) into master (790c6e6) will increase coverage by 2.29%.
The diff coverage is 78.44%.

❗ Current head 27a2946 differs from pull request most recent head 7e819b6. Consider uploading reports for the commit 7e819b6 to get more accurate results

@@            Coverage Diff             @@
##           master     #329      +/-   ##
==========================================
+ Coverage   30.81%   33.10%   +2.29%     
==========================================
  Files          63       65       +2     
  Lines        9574     9509      -65     
==========================================
+ Hits         2950     3148     +198     
+ Misses       6624     6361     -263     
Impacted Files Coverage Δ
bin/dm_blacklist_rm.py 0.00% <0.00%> (ø)
bin/dm_xnat_extract.py 0.00% <0.00%> (ø)
bin/dm_qc_report.py 36.45% <31.92%> (+4.69%) ⬆️
datman/config.py 53.92% <50.00%> (-3.56%) ⬇️
datman/dashboard.py 30.72% <50.00%> (+0.31%) ⬆️
datman/metrics.py 85.48% <85.48%> (ø)
tests/test_dm_qc_report.py 98.11% <97.97%> (-1.89%) ⬇️
tests/test_metrics.py 99.37% <99.37%> (ø)
datman/exceptions.py 84.00% <100.00%> (+1.39%) ⬆️
datman/scan.py 92.92% <100.00%> (-0.22%) ⬇️
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 790c6e6...7e819b6. Read the comment docs.

@DESm1th DESm1th merged commit 87ec9bf into TIGRLab:master Jun 9, 2022
@DESm1th DESm1th deleted the remove_static_pg branch June 9, 2022 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants