Update getting started for ehrql #1371
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
Note that I have not updated the Gitpod screenshots, because Gitpod is currently broken. Addresses part of opensafely-core/ehrql#1676.
Deploying with
|
| Latest commit: |
a6cd204
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2146b632.opensafely-docs.pages.dev |
| Branch Preview URL: | https://update-getting-started-for-e.opensafely-docs.pages.dev |
StevenMaude
approved these changes
Nov 7, 2023
docs/getting-started.md
Outdated
| `opensafely pull cohortextractor`. This will pull down the OpenSAFELY | ||
| cohortextractor images, which can be used to run actions in your study. The | ||
| `opensafely pull ehrql`. This will pull down the OpenSAFELY | ||
| ehrql images, which can be used to run actions in your study. The |
There was a problem hiding this comment.
thought: Unrelated to this PR, is "can be used to run actions in your study" correct here? It doesn't sound quite right to me, but could be my reading.
There was a problem hiding this comment.
It's not quite right, but I'm trying really hard not to get sucked into this stuff!
| file inside the `analysis` folder. This file contains a dataset definition, | ||
| specifying the population that you'd like to study (dataset rows) | ||
| and what you need to know about them (dataset columns). | ||
| It is written in [ehrQL](/ehrql/). |
There was a problem hiding this comment.
suggestion:
Suggested change
| It is written in [ehrQL](/ehrql/). | |
| It is written in [ehrQL](/ehrql/); OpenSAFELY's electronic health record query language. |
I think it's the first time ehrQL is referred to, so worth clarifying for the reader.
|
Looks fine to me; I've added a few suggestions and thoughts. These shouldn't take long to address. |
Co-authored-by: Steven Maude <[email protected]>
Co-authored-by: Steven Maude <[email protected]>
Co-authored-by: Steven Maude <[email protected]>
Co-authored-by: Steven Maude <[email protected]>
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.
No description provided.