opensafely / opensafely/documentation
Remove csv.gz from ehrql tutorials and how-tos
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
Currently, the getting started and many other examples use ehrql, but output csv.gz files rather than arrow.
csv.gz is a very expensive format CPU wise on the server, so we want users to use arrow where ever possible, and so we should update the docs to use arrow outputs.
This may need to be done in co-ordination with https://github.com/opensafely-core/ehrql/issues/2092
Contributor guide
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
Search the getting started guide and other tutorials and how-tos for csv.gz outputs, then review issue 2092 for related changes. Update the documented examples to use arrow outputs wherever appropriate, and confirm that no targeted examples still instruct users to produce csv.gz files.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100