{"id":23288103,"url":"https://github.com/harmonydata/harmony_examples","last_synced_at":"2025-07-11T12:43:30.754Z","repository":{"id":263556669,"uuid":"890772932","full_name":"harmonydata/harmony_examples","owner":"harmonydata","description":"Example Jupyter notebook and R scripts using Harmony in real research problems","archived":false,"fork":false,"pushed_at":"2025-01-13T17:30:03.000Z","size":782,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-18T02:43:04.624Z","etag":null,"topics":["data","data-harmonisation","data-harmonization","harmonisation","psychology","python","r","research"],"latest_commit_sha":null,"homepage":"https://harmonydata.ac.uk/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harmonydata.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-19T06:40:47.000Z","updated_at":"2025-01-13T17:30:07.000Z","dependencies_parsed_at":"2025-01-13T13:32:53.376Z","dependency_job_id":"96c8b2eb-afa7-4cdc-874d-d1eda6af1f92","html_url":"https://github.com/harmonydata/harmony_examples","commit_stats":{"total_commits":20,"total_committers":3,"mean_commits":6.666666666666667,"dds":0.09999999999999998,"last_synced_commit":"b91a76e53395b868deb199ae9834816d214e65b5"},"previous_names":["harmonydata/harmony_examples"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/harmonydata/harmony_examples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmonydata%2Fharmony_examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmonydata%2Fharmony_examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmonydata%2Fharmony_examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmonydata%2Fharmony_examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harmonydata","download_url":"https://codeload.github.com/harmonydata/harmony_examples/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harmonydata%2Fharmony_examples/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264811071,"owners_count":23667672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data","data-harmonisation","data-harmonization","harmonisation","psychology","python","r","research"],"created_at":"2024-12-20T03:14:01.779Z","updated_at":"2025-07-11T12:43:30.741Z","avatar_url":"https://github.com/harmonydata.png","language":"HTML","readme":"![The Harmony Project logo](https://raw.githubusercontent.com/harmonydata/brand/main/Logo/PNG/%D0%BB%D0%BE%D0%B3%D0%BE%20%D1%84%D1%83%D0%BB-05.png)\n\n\u003ca href=\"https://harmonydata.ac.uk\"\u003e\u003cspan align=\"left\"\u003e🌐 harmonydata.ac.uk\u003c/span\u003e\u003c/a\u003e\n\u003ca href=\"https://www.linkedin.com/company/harmonydata\"\u003e\u003cimg align=\"left\" src=\"https://raw.githubusercontent.com//harmonydata/.github/main/profile/linkedin.svg\" alt=\"Harmony | LinkedIn\" width=\"21px\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://twitter.com/harmony_data\"\u003e\u003cimg align=\"left\" src=\"https://raw.githubusercontent.com//harmonydata/.github/main/profile/x.svg\" alt=\"Harmony | X\" width=\"21px\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.instagram.com/harmonydata/\"\u003e\u003cimg align=\"left\" src=\"https://raw.githubusercontent.com//harmonydata/.github/main/profile/instagram.svg\" alt=\"Harmony | Instagram\" width=\"21px\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.facebook.com/people/Harmony-Project/100086772661697/\"\u003e\u003cimg align=\"left\" src=\"https://raw.githubusercontent.com//harmonydata/.github/main/profile/fb.svg\" alt=\"Harmony | Facebook\" width=\"21px\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://www.youtube.com/channel/UCraLlfBr0jXwap41oQ763OQ\"\u003e\u003cimg align=\"left\" src=\"https://raw.githubusercontent.com//harmonydata/.github/main/profile/yt.svg\" alt=\"Harmony | YouTube\" width=\"21px\"/\u003e\u003c/a\u003e\n\n [![Harmony on Twitter](https://img.shields.io/twitter/follow/harmony_data.svg?style=social\u0026label=Follow)](https://twitter.com/harmony_data) \n\n\n# Harmony example scripts\n\nHarmony 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/.\n\nHere you can find example scripts for using the Python and R libraries.\n\n## R examples\n\n* Walkthrough R notebook in R Studio: \u003ca href=\"https://harmonydata.ac.uk/harmony_r_example.nb.html\" target=\"_parent\"\u003e\u003cimg src=\"https://img.shields.io/badge/RStudio-4285F4\" alt=\"Open In R Studio\"/\u003e\u003c/a\u003e\n* Walkthrough R notebook in Google Colab: \u003ca href=\"https://colab.research.google.com/github/harmonydata/experiments/blob/main/Harmony_R_example.ipynb\" target=\"_parent\"\u003e\u003cimg src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/\u003e\u003c/a\u003e [View the PDF documentation of the R package on CRAN](https://cran.r-project.org/web/packages/harmonydata/harmonydata.pdf)\n* [R notebook example](./harmony_workflow_generic.Rmd) - credit to [Nidanur (Nida) Baştürk](https://www.gesis.org/en/institute/about-us/staff/person/Nidanur.Bastuerk)\n* R Markdown to Check for Correspondence between Differently Worded Versions of the Same Scale Item \u003ca target=\"new\"  href=\"https://github.com/harmonydata/harmony_examples/blob/main/R%20Markdown%20to%20Check%20for%20Correspondence%20between%20Differently%20Worded%20Versions%20of%20the%20Same%20Scale%20Item.Rmd\" target=\"_parent\"\u003eView on Github\u003c/a\u003e - credit to [Deanna Varley](https://harmonydata.ac.uk/matilda/)\n* R Script to Check for Matches between Items from Different Scales \u003ca target=\"new\"  href=\"https://github.com/harmonydata/harmony_examples/blob/main/R%20Script%20to%20Check%20for%20Matches%20between%20Items%20from%20Different%20Scales.R\" target=\"_parent\"\u003eView on Github\u003c/a\u003e - credit to [Deanna Varley](https://harmonydata.ac.uk/matilda/)\n\n\n## Python examples\n\n* Walkthrough Python notebook in [Google Colab](https://colab.research.google.com/github/harmonydata/harmony/blob/main/Harmony_example_walkthrough.ipynb) with a single click: \u003ca href=\"https://colab.research.google.com/github/harmonydata/harmony/blob/main/Harmony_example_walkthrough.ipynb\" target=\"_parent\"\u003e\u003cimg src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/\u003e\u003c/a\u003e\n* [Example script to create a crosswalk table on real survey data](./create_harmony_crosswalks_in_python.ipynb)\n* [Example script to strip prefixes from questions](./strip_common_prefixes_from_questions.ipynb)\n\n\n\n## 🖱 Looking to try Harmony in the browser?\n\nVisit: https://harmonydata.ac.uk/app/\n\n## Looking for Harmony source code?\n\nHarmony 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.\n\n   * [Python](https://github.com/harmonydata/harmony) - the main core library and the Python package which is on [Pypi](https://pypi.org/project/harmonydata/)\n   * [R](https://github.com/harmonydata/harmony_r) - the R port is on [CRAN](https://cran.r-project.org/web/packages/harmonydata/index.html) and it is slightly less mature than Python so we really appreciate if you can give the R package some TLC.\n   * [API](https://github.com/harmonydata/harmonyapi) - the Python API runs with Pydantic and Fast API and is running on an on-prem server enabling the web app to work\n   * [Web front end](https://github.com/harmonydata/app) - we welcome feedback and contributions on front end and UX issues\n* If you're doing research and found Harmony useful, please [cite us](/ai-in-mental-health/bmc-psychiatry-paper/)!\n* 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](https://github.com/harmonydata/harmony) or [message us on Discord](https://discord.gg/harmonydata).\n\n[Read our guide to contributing to Harmony here](https://harmonydata.ac.uk/contributing-to-harmony/) or read [CONTRIBUTING.md](https://github.com/harmonydata/harmony/blob/main/CONTRIBUTING.md).\n\n## 🖥 Installation instructions for Python library (video)\n\n[![Installing Harmony](https://raw.githubusercontent.com/harmonydata/.github/main/profile/installation_video.jpg)](https://www.youtube.com/watch?v=enWh0-4I0Sg \"Installing Harmony\")\n\n\n## Who to contact?\n\nYou can contact Harmony team at https://harmonydata.ac.uk/, or Thomas Wood at https://fastdatascience.com/.\n\n\n## ‎😃💁 Who worked on Harmony?\n\nHarmony is a collaboration project between [Ulster University](https://ulster.ac.uk/), [University College London](https://ucl.ac.uk/), the [Universidade Federal de Santa Maria](https://www.ufsm.br/), and [Fast Data Science](http://fastdatascience.com/).  Harmony has been funded by [Wellcome](https://wellcome.org/) as part of the [Wellcome Data Prize in Mental Health](https://wellcome.org/grant-funding/schemes/wellcome-mental-health-data-prize) and by [Economic and Social Research Council (ESRC)](https://www.ukri.org/councils/esrc/).\n\nThe core team at Harmony is made up of:\n\n* [Dr Bettina Moltrecht, PhD](https://profiles.ucl.ac.uk/60736-bettina-moltrecht) (UCL)\n* [Dr Eoin McElroy](https://www.ulster.ac.uk/staff/e-mcelroy) (University of Ulster)\n* [Dr George Ploubidis](https://profiles.ucl.ac.uk/48171-george-ploubidis) (UCL)\n* [Dr Mauricio Scopel Hoffmann](https://ufsmpublica.ufsm.br/docente/18264) (Universidade Federal de Santa Maria, Brazil)\n* [Thomas Wood](https://freelancedatascientist.net/) ([Fast Data Science](https://fastdatascience.com))\n\n\n\n## 📜 License\n\nMIT License. Copyright (c) 2023 Ulster University (https://www.ulster.ac.uk)\n\n## 📜 How do I cite Harmony?\n\nYou can cite our validation paper:\n\n 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](https://bmcpsychiatry.biomedcentral.com/articles/10.1186/s12888-024-05954-2#citeas). BMC Psychiatry 24, 530 (2024), https://doi.org/10.1186/s12888-024-05954-2\n \n\nA BibTeX entry for LaTeX users is\n\n```\n@article{mcelroy2024using,\n  title={Using natural language processing to facilitate the harmonisation of mental health questionnaires: a validation study using real-world data},\n  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},\n  journal={BMC psychiatry},\n  volume={24},\n  number={1},\n  pages={530},\n  year={2024},\n  publisher={Springer}\n}\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharmonydata%2Fharmony_examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharmonydata%2Fharmony_examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharmonydata%2Fharmony_examples/lists"}