Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove outdated references to the learning-ehrql directory #2329

Merged
merged 1 commit into from
Dec 19, 2024
Merged

Remove outdated references to the learning-ehrql directory #2329

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions docs/explanation/running-ehrql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ you can run your dataset definition against dummy tables
to produce an output file that you can inspect.

:computer: Copy and paste the following dataset definition
into a new file called `dataset_definition.py`
and save it in your `learning-ehrql` directory:
into a new file called `dataset_definition.py`:

```ehrql
from ehrql import create_dataset
Expand All @@ -56,8 +55,7 @@ dataset.med_code = latest_asthma_med.dmd_code

Make sure you save the file!

:computer: From the `learning-ehrql` directory,
use the command below to run your dataset definition with ehrQL.
:computer: Use the command below to run your dataset definition with ehrQL.

```
opensafely exec ehrql:v1 generate-dataset dataset_definition.py --dummy-tables example-data --output output/dataset.csv
Expand Down Expand Up @@ -167,7 +165,7 @@ you need to have a file called `project.yaml`.
:notepad_spiral: There is considerably more technical detail on [the project pipeline in the OpenSAFELY documentation](https://docs.opensafely.org/actions-pipelines/).

:computer: Copy the following into a file called
`project.yaml` in your `learning-ehrql` directory:
`project.yaml`:

```yaml
version: '4.0'
Expand Down Expand Up @@ -203,7 +201,7 @@ However, note that the `--output` path is now to a compressed CSV file (`dataset
:notepad_spiral: We recommend the use of compressed CSV files when generating a dataset definition as part of an OpenSAFELY pipeline.

`summarise_dataset` uses a Python script called `summarise_dataset.py`.
Copy the following into a file called `summarise_dataset.py` in your `learning-ehrql` directory.
Copy the following into a file called `summarise_dataset.py`.

```python
import pandas as pd
Expand All @@ -218,8 +216,7 @@ with open("output/summary.txt", "w") as f:
:grey_question: Even if you don't know how to use [pandas](https://pandas.pydata.org/),
can you guess at what this code might do before you run the OpenSAFELY project?

:computer: From the `learning-ehrql` directory,
use the command below to run all of the actions
:computer: Use the command below to run all of the actions
in `project.yaml`:

opensafely run run_all
Expand Down
Loading