opensafely-core / opensafely-core/opencodelists
Make it easier to use a codelist in an OpenSAFELY project
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 60
- Forks
- 16
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 17
Description
We've recently improved the UX for adding a codelist into an OpenSAFELY project. This allows us to provide much more succinct instructions to someone for adding a particular codelist into their project.
We could auto-generate the opensafely cli command, and potentially the ehrql, needed to include any given codelist version into a project, and display this in the left hand information bar. This would then be copied and pasted by a researcher to allow them to easily add the codelist into their project.
Why do this work
- It will make it faster for researchers to perform this really common task.
- It will make it easier for researchers new to OpenSAFELY to get started.
- It will encourage users of OpenCodelists, who aren't currently users of OpenSAFELY, to use the platform.
How will we know when it's done
Researchers are able to look at a particular version of a codelist and see how to easily add it into their project.
Very rough example
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked OpenSAFELY CLI UX issue and the left-hand information bar for a particular codelist version. Trace how the version's details are displayed and determine where the opensafely CLI and potentially ehrql instructions would fit. Done means researchers can view and copy commands for adding that codelist version to their project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100