Add instructions for cohortextractor / ehrql users

This adds instruction to the study_population.py and dataset_definition.py files for cohort-extractor vs ehrql users.
opensafely · Sep 14, 2023 · 84206c8 · 84206c8
1 parent 2b2acd9
commit 84206c8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/analysis/dataset_definition.py b/analysis/dataset_definition.py
@@ -1,3 +1,8 @@
+# Note: If you are using ehrQL to define your study population you need to:
+# (1) uncomment the ehrQL action in the project.yaml file (lines 14-18),
+# (2) delete the cohort-extractor action from the project.yaml file (lines 8-12), and
+# (3) delete the study_definition.py file.
+
 from ehrql import Dataset
 from ehrql.tables.beta.tpp import patients, practice_registrations
 

diff --git a/analysis/study_definition.py b/analysis/study_definition.py
@@ -1,3 +1,7 @@
+# Note: If you are using cohortextrator to define your study population you need to
+# (1) delete the ehrQL action in the project.yaml file (lines 14-18) and
+# (2) delete the dataset_definition.py file.
+
 from cohortextractor import StudyDefinition, patients, codelist, codelist_from_csv  # NOQA