Update readme #115
Update readme #115
Conversation
- Give it a title - Remove "ONLY". from the reason for making public. That's not the sole reason. - The repository may or may not be a valid representation of the study
| * Codelists used to define these variables can be found in the [codelists folder](./codelists/). | ||
| * The project pipeline is specified in [`project.yaml`](./project.yaml). | ||
| * The [logs](./logs/) and [outputs](./outputs/) folders are empty. These are populated when a study is run on OpenSAFELY. Logs and published outputs for analyses run against real patient data are available on OpenSAFELY via the link above. | ||
|
|
There was a problem hiding this comment.
I think it would be helpful to add details of which branch the final analysis for a publication was run on as this isn't always 'main' and is sometimes unclear from the jobs site
There was a problem hiding this comment.
I agree....not sure it fits well in a template such as this? How would you add it?
| # Contents | ||
|
|
||
| * Analysis code can be found in the [analysis folder](./analysis/). | ||
| * If you are interested in how we defined our variables and study population, take a look at the [dataset definition](analysis/dataset_definition.py); this is written in `python`, but non-programmers should be able to understand what is going on there. |
There was a problem hiding this comment.
is non-programmers bit still true with ehrQL?
The ones I have found looked a bit harder than cohort extractor to understand
There was a problem hiding this comment.
It probably is - we may want to test that at some point!
| * Codelists used to define these variables can be found in the [codelists folder](./codelists/). | ||
| * The project pipeline is specified in [`project.yaml`](./project.yaml). | ||
| * The [logs](./logs/) and [outputs](./outputs/) folders are empty. These are populated when a study is run on OpenSAFELY. Logs and published outputs for analyses run against real patient data are available on OpenSAFELY via the link above. | ||
|
|
There was a problem hiding this comment.
I agree....not sure it fits well in a template such as this? How would you add it?
| @@ -1,8 +1,14 @@ | |||
| # ${GITHUB_REPOSITORY_NAME} | |||
There was a problem hiding this comment.
This needs instructions for an analyst on what to do once they clone the template
E.g. When you first clone you should change {github-reposiroy-name} to x
You may want to link to other information about your project for example if you have standalone website
Once your study is published it is a good idea to update the repo with DOI for your paper so interested readrs can read more
Suggest these are written in italics - and first bit of advice is. Once you have tweaked the information you should delete the instructions in italics
This addresses https://github.com/ebmdatalab/service-analytics-team/issues/254.
This is draft as it requires the text pointing to codespaces to be finalised.
Closes https://github.com/ebmdatalab/service-analytics-team/issues/254