harmony_examples
Example Jupyter notebook and R scripts using Harmony in real research problems
Science Score: 57.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.1%) to scientific vocabulary
Keywords
Repository
Example Jupyter notebook and R scripts using Harmony in real research problems
Basic Info
- Host: GitHub
- Owner: harmonydata
- License: mit
- Language: HTML
- Default Branch: main
- Homepage: https://harmonydata.ac.uk/
- Size: 764 KB
Statistics
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
Harmony example scripts
Harmony is a tool using AI which allows you to compare items from questionnaires and identify similar content. You can try Harmony at https://harmonydata.ac.uk/app and you can read our blog at https://harmonydata.ac.uk/blog/.
Here you can find example scripts for using the Python and R libraries.
R examples
- Walkthrough R notebook in R Studio:
- Walkthrough R notebook in Google Colab:
View the PDF documentation of the R package on CRAN - R notebook example - credit to Nidanur (Nida) Baştürk
- R Markdown to Check for Correspondence between Differently Worded Versions of the Same Scale Item View on Github - credit to Deanna Varley
- R Script to Check for Matches between Items from Different Scales View on Github - credit to Deanna Varley
Python examples
- Walkthrough Python notebook in Google Colab with a single click:
- Example script to create a crosswalk table on real survey data
- Example script to strip prefixes from questions
🖱 Looking to try Harmony in the browser?
Visit: https://harmonydata.ac.uk/app/
Looking for Harmony source code?
Harmony is based on four repositories: the core Python library, the API, the R port, and the front end for running in the browser. We welcome contributions and you can raise issues, pick up issues, and make pull requests.
- Python - the main core library and the Python package which is on Pypi
- R - the R port is on CRAN and it is slightly less mature than Python so we really appreciate if you can give the R package some TLC.
- API - the Python API runs with Pydantic and Fast API and is running on an on-prem server enabling the web app to work
- Web front end - we welcome feedback and contributions on front end and UX issues
- If you're doing research and found Harmony useful, please cite us!
- If you're a researcher trying to use the tool, and you encounter a problem, a bug, or a feature which you would like us to implement, please raise an issue on Github or message us on Discord.
Read our guide to contributing to Harmony here or read CONTRIBUTING.md.
🖥 Installation instructions for Python library (video)
Who to contact?
You can contact Harmony team at https://harmonydata.ac.uk/, or Thomas Wood at https://fastdatascience.com/.
😃💁 Who worked on Harmony?
Harmony is a collaboration project between Ulster University, University College London, the Universidade Federal de Santa Maria, and Fast Data Science. Harmony has been funded by Wellcome as part of the Wellcome Data Prize in Mental Health and by Economic and Social Research Council (ESRC).
The core team at Harmony is made up of:
- Dr Bettina Moltrecht, PhD (UCL)
- Dr Eoin McElroy (University of Ulster)
- Dr George Ploubidis (UCL)
- Dr Mauricio Scopel Hoffmann (Universidade Federal de Santa Maria, Brazil)
- Thomas Wood (Fast Data Science)
📜 License
MIT License. Copyright (c) 2023 Ulster University (https://www.ulster.ac.uk)
📜 How do I cite Harmony?
You can cite our validation paper:
McElroy, Wood, Bond, Mulvenna, Shevlin, Ploubidis, Scopel Hoffmann, Moltrecht, Using natural language processing to facilitate the harmonisation of mental health questionnaires: a validation study using real-world data. BMC Psychiatry 24, 530 (2024), https://doi.org/10.1186/s12888-024-05954-2
A BibTeX entry for LaTeX users is
@article{mcelroy2024using,
title={Using natural language processing to facilitate the harmonisation of mental health questionnaires: a validation study using real-world data},
author={McElroy, Eoin and Wood, Thomas and Bond, Raymond and Mulvenna, Maurice and Shevlin, Mark and Ploubidis, George B and Hoffmann, Mauricio Scopel and Moltrecht, Bettina},
journal={BMC psychiatry},
volume={24},
number={1},
pages={530},
year={2024},
publisher={Springer}
}
Owner
- Name: Harmony
- Login: harmonydata
- Kind: organization
- Location: United Kingdom
- Website: https://harmonydata.org
- Twitter: harmony_data
- Repositories: 1
- Profile: https://github.com/harmonydata
Harmonising mental health data with natural language processing
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Wood" given-names: "Thomas" orcid: "https://orcid.org/0000-0001-8962-8571" - family-names: "McElroy" given-names: "Eoin" orcid: "https://orcid.org/0000-0001-5466-8522" - family-names: "Moltrecht" given-names: "Bettina" orcid: "https://orcid.org/0000-0002-1838-428X" - family-names: "Scopel Hoffmann" given-names: "Mauricio" orcid: "https://orcid.org/0000-0003-4232-3169" - family-names: "Ploubidis" given-names: "George" orcid: "https://orcid.org/0000-0002-8198-5790" title: "Harmony" version: 1.0.0 doi: DOI 10.17605/OSF.IO/BCT6K date-released: 2023-07-22 url: "https://harmonydata.ac.uk"
GitHub Events
Total
- Watch event: 2
- Delete event: 1
- Issue comment event: 1
- Member event: 1
- Push event: 23
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
- Create event: 3
Last Year
- Watch event: 2
- Delete event: 1
- Issue comment event: 1
- Member event: 1
- Push event: 23
- Pull request review event: 1
- Pull request event: 3
- Fork event: 1
- Create event: 3
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Thomas Wood | t****s@f****m | 21 |
| deannavarley | 1****y | 1 |
| bastuenr | N****k@g****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 0
- Total pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 5 hours
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 5 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- deannavarley (2)
- nida-basturk (1)