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

Jump to bottom

Update project.yaml examples to pipeline v4 if the example only has ehrQL actions #1639

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update project.yaml examples to pipeline v4 if the example only has ehrQL actions #1639

Show file tree
Hide file tree
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
8 changes: 2 additions & 6 deletions docs/actions-pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ It is written using a configuration format called [YAML](https://yaml.org/), whi
A simple example of a `project.yaml` is as follows:

```yaml
version: "3.0"

# Ignore this `expectations` block. It is required but not used, and will be removed in future versions.
expectations:
population_size: 1000
version: "4.0"

actions:
generate_dataset:
Expand Down Expand Up @@ -60,7 +56,7 @@ The `run_model` action will run a Stata script called `model.do` based on the `d
It will output two moderately sensitive files `cox-model.txt` and `survival-plot.png`, which can be checked and released if appropriate.


Every `project.yaml` requires a `version`, `expectations`, and `actions` section.
Every `project.yaml` requires a `version` and `actions` section. An `expectations` section was also required for version 3.0 of the pipeline framework (example [here](case-control-studies.md)), but is not used in the latest version.
In general, actions are composed as follows:

* Each action must be named using a valid YAML key (you won't go wrong with letters, numbers, and underscores) and must be unique.
Expand Down
12 changes: 2 additions & 10 deletions docs/getting-started/tutorial/add-a-scripted-action-to-the-pipeline/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,7 @@ This code reads the CSV of patient data, and saves a histogram of ages to a new
=== "Python"

```yaml linenums="1" hl_lines="14 15 16 17 18 19"
version: "3.0"

# Ignore this `expectations` block. It is required but not used, and will be removed in future versions.
expectations:
population_size: 1000
version: "4.0"

actions:
generate_dataset:
Expand All @@ -91,11 +87,7 @@ This code reads the CSV of patient data, and saves a histogram of ages to a new
=== "R"

```yaml linenums="1" hl_lines="14 15 16 17 18 19"
version: "3.0"

# Ignore this`expectation` block. It is required but not used, and will be removed in future versions.
expectations:
population_size: 1000
version: "4.0"

actions:
generate_dataset:
Expand Down
6 changes: 1 addition & 5 deletions docs/getting-started/tutorial/run-the-project-pipeline/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,7 @@ open the `project.yaml` file by clicking on it. This file will be near the end o
You should see a tab with the following content:

```yaml linenums="1" hl_lines="9"
version: "3.0"

# Ignore this `expectations` block. It is required but not used, and will be removed in future versions.
expectations:
population_size: 1000
version: "4.0"

actions:
generate_dataset:
Expand Down