From 5f38ab7a5576b3c5335580b4b654dd8ce37945e7 Mon Sep 17 00:00:00 2001 From: Peter Inglesby Date: Fri, 24 Nov 2023 15:58:30 +0000 Subject: [PATCH] Drop requesting-variables page --- docs/how-to-get-help.md | 2 +- docs/requesting-variables.md | 22 ---------------------- mkdocs.yml | 1 - 3 files changed, 1 insertion(+), 24 deletions(-) delete mode 100644 docs/requesting-variables.md diff --git a/docs/how-to-get-help.md b/docs/how-to-get-help.md index f13420291..926061cdb 100644 --- a/docs/how-to-get-help.md +++ b/docs/how-to-get-help.md @@ -74,7 +74,7 @@ OpenSAFELY uses GitHub to manage and share code and other platform resources. If Issues can be submitted for lots of different things — new variables or other features, bug reports, additional R or Stata packages, documentation updates, and so on. All our core software packages live in the [`opensafely-core`](https://github.com/opensafely-core/) GitHub organisation. -The most common requests are about library support, and new study definition variables. We have a whole page describing [how to request new libraries](requesting-libraries.md), and another about [how to request new study variables](requesting-variables.md). If you want to report bugs or request features in the `opensafely` command-line tool, you can do so in [its own dedicated issue tracker](https://github.com/opensafely-core/opensafely-cli/issues). +The most common requests are about library support; this page describes [how to request new libraries](requesting-libraries.md). If you want to report bugs or request features in the `opensafely` command-line tool, you can do so in [its own dedicated issue tracker](https://github.com/opensafely-core/opensafely-cli/issues). Other than this, you will need to choose the most appropriate repo to submit an issue. If you're not sure where to submit your issue, just ask a question in our [Q&A forum](https://github.com/opensafely/documentation/discussions) and we can point you to the right place. diff --git a/docs/requesting-variables.md b/docs/requesting-variables.md deleted file mode 100644 index e1b51052e..000000000 --- a/docs/requesting-variables.md +++ /dev/null @@ -1,22 +0,0 @@ -To request new functions that create variables via a study definition, follow these instructions: - -* Browse the [study definition variables](study-def-variables.md) page to see all possible variables that can currently be extracted with a study definition, and check that the variable you want doesn't already exist. If you're not sure, read about OpenSAFELY [study definitions](study-def.md) to understand the way in which the database is queried and data extracts are generated. -* Browse the [data sources](../data-sources/) page to see what data is available in each backend. -* View the [OpenSAFELY-TPP database update notebook](https://reports.opensafely.org/reports/opensafely-tpp-database-builds/) to see when each data source was updated. -* View the [OpenSAFELY-TPP schema notebook](https://reports.opensafely.org/reports/opensafely-tpp-database-schema/) to see the structure of the database. -* Check that the variable has not already been requested as an issue in the [`cohort-extractor`](https://github.com/opensafely-core/cohort-extractor) repository. Look at both _open_ and _closed_ issues in case the variable has been considered unworkable or low priority. - - -If after reviewing these resources you think the information you need might be in the database, but you can’t extract it with a study definition (for example because the variable extractor function doesn’t exist, or the structure of extracted data doesn’t allow for it), then: - -* Create a new issue in the [`cohort-extractor`](https://github.com/opensafely-core/cohort-extractor) repository, and add the `enhancement` label -* Explain the rationale -* Where possible, describe how you expect the function to look for this variable, or how it will modify or enhance an existing variable: - * what will it be called? - * what are the function arguments? - * what are the returning values? -* Where possible, provide example SQL code for the underlying database query (it doesn't have to be perfect). - - - ----8<-- 'includes/glossary.md' diff --git a/mkdocs.yml b/mkdocs.yml index 7bd962509..f3413991f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,7 +82,6 @@ nav: - How to get help: how-to-get-help.md - OpenSAFELY co-piloting service: copiloting-service.md - Requesting new libraries: requesting-libraries.md - - Requesting study definition variables: requesting-variables.md - Plan S and OpenSAFELY: plan-s.md - Updating the documentation: updating-the-docs.md - Bennett Institute Open Manifesto: open-data-manifesto.md