Add ehrQL placeholders #106
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is not a direct translation of the cohort-extractor example in study_definition.py. I thought it would be useful to show how to add a column to the dataset using an ehrql method (age_on) and show how to use two conditions to define the pupulation using &.
This adds instruction to the study_population.py and dataset_definition.py files for cohort-extractor vs ehrql users.
inglesp
approved these changes
Sep 15, 2023
Maybe? But we don't need to decide that now. Do we need to update anything in the docs? |
Agree!
At this stage I don't think we have to change anything. I looked at the docs and the research template gets a lot of mentions but because we didn't change the default behaviour I think we can merge this without making changes to the docs! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a placeholer ehrql dataset definition and action with instructions for cohortextractor and ehrql users at the top of each script (
dataset_definition.pyandstudy_definition.py).This will be helpful for creating ehrQL documentation and examples because if gives us a starting point that is easy for users to get to. It's also a good to introduce ehrql in the research template simply because we are moving away from cohortextractor.
The
dataset_definition.pyis not a direct translation of thestudy_definition.pybecause I think it's good to use an ehrql method (age_on) in the example and show how a population can be defined using two conditions.However, we should have think if this is a good starting point for all studies that use the research-template or whether we want to make it more simple/complex?