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

Updates to the EDRN Data Model #385

Closed
hoodriverheather opened this issue Jan 7, 2025 · 12 comments
Closed

Updates to the EDRN Data Model #385

hoodriverheather opened this issue Jan 7, 2025 · 12 comments
Assignees
Labels
🧙‍♀️enhancement New feature or request ✅ QC Quality assurance confirmed
Milestone

Comments

@hoodriverheather
Copy link

hoodriverheather commented Jan 7, 2025

Please update the EDRN Data Model Tool posted on the Portal:

https://edrn.nci.nih.gov/data-and-resources/cde/edrn-data-model/
  • Separate the Models: Split the Biomarker and Data Commons models to improve clarity and usability.

  • Revise the Spreadsheet:

    • Include only relevant data model information in the posted spreadsheet.
    • Add a README tab at the beginning, and either remove the Structure tab, if possible, or move it to the end with an explanation in the README. Use the README tab in the EDRN LabCAS Data Model Sheet as a reference.
  • Add Navigation Instructions: Include instructions for navigating the Biomarker Data Models and Cancer Biomarker Data Commons (LabCAS Data Model).

@elawsgh - please add comments if there’s anything you’d like to clarify or add.

DataModel-1 DataModel-2

NOTE: Updated bullet list above to indent items specific to "Revise the Spreadsheet"

@hoodriverheather hoodriverheather added the 🧙‍♀️enhancement New feature or request label Jan 7, 2025
@nutjob4life nutjob4life added this to the 6.17 milestone Jan 10, 2025
@nutjob4life
Copy link
Member

nutjob4life commented Jan 10, 2025

@hoodriverheather the "Structure" tab is necessary since it contains the description of each entity in the model, the stewardship information, and, critically, the parent/child relationships of each entity. We can move it to the end, but deleting it is impossible.

For reference:

To do:

  • README from this spreadsheet copied to the above two new spreadsheets.
  • Note on the "Structure" tab added to each spreadsheet
  • Update software

@nutjob4life
Copy link
Member

nutjob4life commented Jan 10, 2025

Technical notes:

(These are for @nutjob4life's reference. No need to even read this.)

  • Class CDEExplorerPage should go away (but not in this release since we need it to support deleting it)
  • Replace the edrn-data-model (via slug) with a FlexPage (management command)
  • Move (or dupe) GDrive and tree nodes from edrnsite.content to edrnsite.streams
  • Tie specific tree roots to a Wagtail "block"
  • Inject footer JavaScript if tree "block" is present to activate the triangles
  • Add issue to remove obsolete CDEExplorerPage in future release, see Remove obsolete CDEExplorerPage #388
  • Fitting multiple "Update from Google Drive" buttons tricky—use a single site-wide button?

nutjob4life added a commit that referenced this issue Jan 15, 2025
@nutjob4life
Copy link
Member

@hoodriverheather ready for you to take a look

Some things to note:

  • There's a lot more flexibility now in that a "data element explorer" is now just another block type, like a "rich text block" or a "typed table block", and these can go on any "web page" type now or in the future
  • There's some limitations about what text can go where, so things don't exactly match your red text in the screenshots above
  • The link to the data model page is the same but changing the content type removes the link from the parent page; don't be alarmed. It's best to "fix it in post" using Wagtail editing (takes 60 seconds) than write the 50 lines of code needed to do it with the release (takes 2 hours)

If you want to go over it together, that's fine too. Thanks for your patience! As you can see from the diffs, this was a big change

@hoodriverheather
Copy link
Author

@nutjob4life this is looks good! The link to the to open the LabCAS data model sheet isn't working. See screenshot below. If i want to updated the readme tab, can I just use the link in the comment above? That link works :)
Screenshot 2025-01-15 at 5 12 21 PM

Gotta go make dinner - I'll keep testing tomorrow.

@nutjob4life
Copy link
Member

@hoodriverheather nice catch! I've made the software fix and am re-deploying the dev site. It should be ready in about 15 minutes.

@hoodriverheather hoodriverheather added the ✅ QC Quality assurance confirmed label Jan 16, 2025
@hoodriverheather
Copy link
Author

@nutjob4life looks great!

@nutjob4life
Copy link
Member

Thanks @hoodriverheather! Will include this in the code-freeze for release to NCI.

@hoodriverheather
Copy link
Author

@nutjob4life Thanks! Just now wondering if Emily should take a look before you push. She's the one that made the suggested updates and is not as familiar as we are with how to use this page. WDYT?

@nutjob4life
Copy link
Member

Tagging @elawsgh

Did you want to take a look at this too?

Does it look okay? The code freeze is 2025-01-17 at 3pm PT. If you don't want these features to go out, say so ASAP.

@elawsgh
Copy link

elawsgh commented Jan 16, 2025

@nutjob4life @hoodriverheather I did review it yesterday when I got the message. I really like how it was implemented and noticed the LabCAS data model sheet couldn't be opened, and then saw that Heather has pointed it out. So all is good now and please get it out when you can. Thanks!

@elawsgh elawsgh removed their assignment Jan 16, 2025
@nutjob4life
Copy link
Member

@elawsgh thank you! This will be included in the code freeze.

Have a nice day everyone.

@nutjob4life
Copy link
Member

@elawsgh and @hoodriverheather this is now live in production

One further refinement which we can do outside of the software release is get rid of the top level "root" triangles which seem redundant. When everything was in one "tree", it made sense, but now that there are two "trees" under big level-2 headings, it seems like we're forcing an extra click on users now.

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧙‍♀️enhancement New feature or request ✅ QC Quality assurance confirmed
Projects
None yet
Development

No branches or pull requests

3 participants