From 126537a37a024d51af2f840d55e452a9f3b99e0e Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:32:42 +0100 Subject: [PATCH 1/6] Update workflow.md --- docs/workflow.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/workflow.md b/docs/workflow.md index d12f924a..659ca030 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -10,10 +10,10 @@ This repo will contain all the code relating to your project, and a history of i 2. **Write a [dataset definition](/ehrql/)** that specifies what data you want to extract from the database: - specify the patient population (dataset rows) and variables (dataset columns) - specify the expected distributions of these variables for use in dummy data - - specify (or create) the [codelists](codelist-intro.md) required by the study definition, hosted by [OpenCodelists](https://www.opencodelists.org), and import them to the repo. + - specify (or create) the [codelists](codelist-intro.md) required by the dataset definition, hosted by [OpenCodelists](https://www.opencodelists.org), and import them to the repo. 3. **Generate [dummy data](/ehrql/how-to/dummy-data)** based on the dataset definition, for writing and testing code. 4. **Develop analysis scripts** using the dummy data in R, Stata, or Python. This will include: - - importing and processing the dataset(s) created by the cohort extractor + - importing and processing the dataset(s) created by the [dataset definition](/ehrql/) - importing any other external files needed for analysis - generating analysis outputs like tables and figures - generating log files to debug the scripts when they run on the real data. @@ -29,4 +29,4 @@ It is possible to automatically test that the analytical pipeline defined in ste This pipeline is also [automatically tested](actions-pipelines.md#running-your-code-with-github-actions) against dummy data every time a new version of the study repository is saved ("pushed") to GitHub. As well as your own Python, R or Stata scripts, other non-standard actions are available. -For example, it's possible to run a matching routine that extracts a matched control population to the population defined in the study definition, without having to extract all candidate matches into a dataset first. +For example, it's possible to run a matching routine that extracts a matched control population to the population defined in the dataset definition, without having to extract all candidate matches into a dataset first. From 25227d0745b31cdc9547fa708d8ba35eba9a4623 Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:35:48 +0100 Subject: [PATCH 2/6] Update repositories.md --- docs/repositories.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/repositories.md b/docs/repositories.md index fe3c0aac..ff3cc5a1 100644 --- a/docs/repositories.md +++ b/docs/repositories.md @@ -74,7 +74,7 @@ This is an important folder, used internally by GitHub, that you can happily ign By convention, this folder contains: -* Any `study_definition.py` script that defines the study definition +* Any `dataset_definition.py` script that defines the dataset definition * Analysis scripts in R, Python or Stata ### `codelists/` From d2816f976b95e925148717a983fa2041a773d820 Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:39:25 +0100 Subject: [PATCH 3/6] Update codelist-intro.md --- docs/codelist-intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/codelist-intro.md b/docs/codelist-intro.md index c2a6cb6f..11d08745 100644 --- a/docs/codelist-intro.md +++ b/docs/codelist-intro.md @@ -19,8 +19,8 @@ that to find all the patients with Type 1 diabetes, you may have to search for We built a system for building, reviewing and maintaining codelists at [OpenCodelists](https://www.opencodelists.org/). We've made an introductory video to help explain OpenCodelists in more detail. Codelists -that are hosted on this website can be used directly in the Study Definition. This means -there is no need to download or alter these codelists in the study definition, and +that are hosted on this website can be used directly in the Dataset Definition. This means +there is no need to download or alter these codelists in the dataset definition, and they can be reused.
From fcaa8b089eb9870e1afb0ed279071ccb7e394e36 Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:41:59 +0100 Subject: [PATCH 4/6] Update codelist-creation.md --- docs/codelist-creation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/codelist-creation.md b/docs/codelist-creation.md index 60442183..54946826 100644 --- a/docs/codelist-creation.md +++ b/docs/codelist-creation.md @@ -107,7 +107,7 @@ Go to the codelist issue in the [codelist repo](https://github.com/opensafely/co This issue serves as documentation of the choices made that determined the final codelist. The issue can be re-opened if revisions are required. -## Import the codelist for use in your study definition +## Import the codelist for use in your dataset definition Once the codelist is in [OpenCodelists](https://www.opencodelists.org), you can retrieve it for use in your research repo. Follow the [adding codelists to project instructions](codelist-project.md) if you're not sure how to do this. From 98d8310cec6e3cacc2ce4622af36f0a09751601b Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:43:57 +0100 Subject: [PATCH 5/6] Update how-to-get-help.md --- docs/how-to-get-help.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-get-help.md b/docs/how-to-get-help.md index a117150d..85f85c38 100644 --- a/docs/how-to-get-help.md +++ b/docs/how-to-get-help.md @@ -66,7 +66,7 @@ To search the OpenSAFELY GitHub organisation for code: 4. Select "Code" to find any matches within previous code (or sometimes "Issues" may help). It can be helpful to use the option to filter the results by language. -For example, restricting to Python might help you find study definition files. +For example, restricting to Python might help you find dataset definition files. ## Bug reports and feature requests From ff362a90bfaf00061dbd48d2f4ea5214db04a067 Mon Sep 17 00:00:00 2001 From: Andrea Schaffer <37759997+alschaffer@users.noreply.github.com> Date: Fri, 4 Oct 2024 13:54:01 +0100 Subject: [PATCH 6/6] Update workflow.md --- docs/workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/workflow.md b/docs/workflow.md index 659ca030..b997a9e6 100644 --- a/docs/workflow.md +++ b/docs/workflow.md @@ -13,7 +13,7 @@ This repo will contain all the code relating to your project, and a history of i - specify (or create) the [codelists](codelist-intro.md) required by the dataset definition, hosted by [OpenCodelists](https://www.opencodelists.org), and import them to the repo. 3. **Generate [dummy data](/ehrql/how-to/dummy-data)** based on the dataset definition, for writing and testing code. 4. **Develop analysis scripts** using the dummy data in R, Stata, or Python. This will include: - - importing and processing the dataset(s) created by the [dataset definition](/ehrql/) + - importing and processing the dataset(s) created by the dataset definition - importing any other external files needed for analysis - generating analysis outputs like tables and figures - generating log files to debug the scripts when they run on the real data.