Skip to content

Conversation

@Bpriya42
Copy link

@Bpriya42 Bpriya42 commented Sep 16, 2025

Description

This PR implements the ability to automatically download a Jupyter notebook template alongside the existing Excel export functionality, addressing the need for users to analyze their harmonized datasets programmatically.

When users click the "Export" button on the model results page, they now receive:

  1. The existing Excel file with match results and similarity matrix
  2. A Jupyter notebook template (harmony_analysis_template.ipynb) for further data analysis

The notebook template includes:

  1. Instructions for loading and analyzing the exported Excel data
  2. Example code for statistical analysis incorporating Harmony similarity scores
  3. Guidance on creating weighted variables based on match scores (e.g., 0.65 × Instr1Ques1 + 0.33 × Instr2Ques5)
  4. Templates for common statistical tests on harmonized data

This approach allows users to complete their data harmonization workflow on their local machines, addressing confidentiality concerns when raw data cannot be uploaded to web services.

Fixes harmonydata/harmony#40

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Requires a documentation revision

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@netlify
Copy link

netlify bot commented Sep 16, 2025

Deploy Preview for harmony-staging ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/projects/harmony-staging/deploys/68d98ae4b842aeee901b34fe
😎 Deploy Preview https://deploy-preview-53--harmony-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Bpriya42 Bpriya42 marked this pull request as draft September 16, 2025 03:42
@jaydugad
Copy link

Thanks for putting this together, @Bpriya42 . The approach makes sense, and I like the idea of providing a notebook template alongside the Excel export. Since this is still marked as a draft, I’ll wait until you mark it ready for review before doing a full test/review. Let me know once the Netlify preview is available so I can check the download workflow end-to-end.

@Bpriya42 Bpriya42 marked this pull request as ready for review September 18, 2025 00:41
@Bpriya42
Copy link
Author

Hey @jaydugad, I'm not sure why the Netlify deployment is failing. Do you have any guidance on how to fix this? Thanks!

@jaydugad
Copy link

Hey @Bpriya42 , no worries - Netlify can be a bit temperamental sometimes. From the looks of it, the failures are around the header/redirect rules rather than anything in your code.
A couple of quick things you could try:

  1. Double-check that nothing new in the public/ folder is clashing with _headers or _redirects.
  2. Since we added a .ipynb file, it might need a tweak in the Netlify config (netlify.toml or _headers).
  3. You could also just re-run the deploy from the Netlify dashboard in case it was a one-off glitch.

If it still doesn’t work after that, let me know and I’ll take a closer look at the deploy logs with you.

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.

Allow user to process data

2 participants