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.

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

Update links to example research code where that code is old and unmaintained #1573

Open
6 of 9 tasks
StevenMaude opened this issue Jul 17, 2024 · 6 comments
Open
6 of 9 tasks
Assignees
Labels
improve content Improve existing documentation content

Comments

@StevenMaude
Copy link
Contributor

StevenMaude commented Jul 17, 2024

In #1572, it was noted that there is at least one link to research code that doesn't do things exactly as might be the OpenSAFELY best practice today (it uses run: jupyter:latest and not run: python:v2).

Links to code repositories are currently in:

  • docs/data-sources/apc.md
  • docs/data-sources/ecds.md
  • docs/data-sources/systmone.md
  • docs/data-sources/cpns.md
  • docs/federation.md
  • docs/protocol.md
  • docs/reports/intro.md
  • docs/study-def-flowcharts.md
  • docs/study-def-tricks.md

If these are outdated, we should replace them with more current examples.

@StevenMaude StevenMaude added the improve content Improve existing documentation content label Jul 17, 2024
@lucyb
Copy link
Contributor

lucyb commented Jul 24, 2024

I've spoken to Brian and someone in the research team will be able to update this code.

@wjchulme wjchulme self-assigned this Jul 30, 2024
@wjchulme
Copy link
Contributor

no action needed

  • The links from the data source pages are fine.
  • The study-def-flowcharts.md and study-def-tricks.md are now under legacy so can stay as is.

non-urgent action needed

  • The walkthrough in docs/federation.md should be replaced with an example in ehrQL, when such an example exists. The text currently acknowledges that the example is outdated as it uses study definitions, so think that enough until we can fully replace.
  • The docs/protocol.md page links to protocols in repos, not code, so this is fine. Though we may want to update to more recent examples at some stage.
  • The report/intro.md page includes one link to code that is out-of-date

@alschaffer
Copy link
Contributor

Don't know if this fits here, but some references to modifying study def variables in cohortextractor here:
"Making changes to the study definition variables"
https://docs.opensafely.org/updating-the-docs/

I'm not even sure what that paragraph is about so unsure if it needs updating, or deleting (I suspect the latter though).

StevenMaude added a commit that referenced this issue Oct 9, 2024
As spotted by @alschaffer in this issue:

#1573 (comment)

The relevant file has been edited just four times in the last two years,
and not since mid-2023.

Realistically, the only people who might make small updates to
cohort-extractor are likely to be developers now, and this note probably
just mystifies anyone else who encounters it.
@StevenMaude
Copy link
Contributor Author

I'm not even sure what that paragraph is about so unsure if it needs updating, or deleting (I suspect the latter though).

It's not really helpful now as it doesn't apply to ehrQL, so I deleted it in #1642.

@rebkwok
Copy link
Contributor

rebkwok commented Oct 18, 2024

@StevenMaude While updating docs (#1639) on the new project.yaml version (which deprecated cohort-extractor), @alarthast noticed that there is also the case control studies example in docs/case-control-studies.md which is still using cohort-extractor code. Can we add this one to your list, please?

@alschaffer
Copy link
Contributor

@rebkwok There is already an issue for the case control page (#1492) - it is awaiting a decision on whether to delete or rewrite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve content Improve existing documentation content
Projects
None yet
Development

No branches or pull requests

5 participants