From 78a45913e76392748daf28c801de17dfd835b7ed Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Tue, 15 Nov 2022 12:00:43 +0000 Subject: [PATCH 01/12] Adding copiloting documentation --- docs/copiloting-service.md | 132 +++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 docs/copiloting-service.md diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md new file mode 100644 index 000000000..e6df9fac4 --- /dev/null +++ b/docs/copiloting-service.md @@ -0,0 +1,132 @@ +# OpenSAFELY copiloting service + +## What is the OpenSAFELY copiloting service? + +All new users of the OpenSAFELY platform are offered access to our copilot service, which pairs the new user (the "pilot") with an experienced OpenSAFELY researcher (the "copilot") to help with the onboarding process. The objective of this service is to help new users get up and running with OpenSAFELY as quickly as possible and aims to facilitate the generation of analytical outputs from real data within a four week period. + +The service includes: +- dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform +- community support via GitHub forums and the #opensafely-users Slack channel +- GitHub introduction and coaching +- output checking service +- manuscript review +- opportunities to present at quarterly OpenSAFELY User Group meetings + +## What are the aims of the OpenSAFELY copiloting service? + +By the end of the 4 week period, pilots should: + +* Be familiar with the core OpenSAFELY concepts (study definition, actions, running locally vs running in job server, requesting output release, codelists) +* Be able to run the OpenSAFELY environment locally and on the job server +* Have generated the study population for their project +* Run analysis scripts on the population +* Generated outputs ready for review + +## How does the copiloting service run? + +The diagram below illustrates how a project will progress through the copiloting service. More information about each stage is provided in subsections below. + +```mermaid +graph TD + subgraph setup_stage[" "] + application_submission[Project application] + application_approval[Project approval] + application_submission --> application_approval + getting_started[Completing Getting Started guide] + end + + subgraph assignment_stage[" "] + copilot_assignment[Assignment of copilot] + introductory_meeting[Introductory meeting] + copilot_assignment --> introductory_meeting + end + subgraph copiloting_stage[" "] + subgraph dedicated_support[1:1 support] + active_copiloting[Weekly meetings\nCohort review] + end + subgraph wider_support[Community support] + wider_support_details[Discussion forum\nUsers Slack channel] + end + output_checking[Output checking] + end + subgraph post_copiloting_stage[" "] + subgraph wider_support_post[Community support] + wider_support_details_post[Discussion forum\nUsers Slack channel] + end + manuscript_review[Manuscript review] + output_checking_post[Output checking] + end + + getting_started --> assignment_stage + application_approval --> assignment_stage + introductory_meeting --> copiloting_stage + copiloting_stage --> post_copiloting_stage + + style setup_stage fill:#f7fcb9,stroke:#AAA,stroke-width:4px + style assignment_stage fill:#addd8e,stroke:#333,stroke-width:4px + style copiloting_stage fill:#31a354,stroke:#333,stroke-width:4px + style post_copiloting_stage fill:#fff,stroke:#333,stroke-width:4px +``` + +```mermaid +graph LR + subgraph key[" "] + setup_key["Application and setup stage"] + assignment_key["Assignment stage"] + copiloting_key["Active copiloting stage"] + post_copiloting_key["Post copiloting stage"] + end + style setup_key fill:#f7fcb9,stroke:#AAA,stroke-width:4px + style assignment_key fill:#addd8e,stroke:#333,stroke-width:4px + style copiloting_key fill:#31a354,stroke:#333,stroke-width:4px + style post_copiloting_key fill:#fff,stroke:#333,stroke-width:4px +``` + +### Project application and software setup + +All projects need to have sought and been granted [IG approval](https://www.opensafely.org/policies-for-researchers/) before a copilot can be requested and assigned. We also ask that new users complete the OpenSAFEELY [Getting Started guide](https://docs.opensafely.org/en/latest/getting-started/) to ensure that the necessary software can be installed and run on your computer. + +In our experience, copiloting is most successful when the pilot has some experience with coding (e.g., Python, R or Stata), is familiar with collaborative code development via GitHub and is able to commit four weeks or more to their project. + +If you are unsure whether copiloting will work for your project, contact `team@opensafely.org` or use the [contact form on our website](https://www.opensafely.org/contact/). + +### Assignment of copilot + +Once a project has been approved, it will be matched to one of our internal OpenSAFELY researchers, in terms of the experience and knowledge required for the project. The pilot and copilot will have an introductory meeting in which the copilot will provide further details about the copiloting service and the pilot can provide further details about the research project. At this meeting, both parties will agree when the dedicated 1:1 support period will begin. + +### Active copiloting stage (four weeks) + +The four week period of copiloting is intended to provide a supportive, encouraging environment in which a new user can become familiar with how to build and run a research study using the OpenSAFELY platform. In our experience, pilots get the most out of the service if they are able to focus exclusively on the project for the four week period. + +Copilots will provide up to five days over the four weeks to support the development of the research study. This support includes: + +- explaining and demonstrating how OpenSAFELY works +- weekly meetings to scope out achievable weekly objectives and tackle problems +- support with the construction of the required patient cohort +- support with the identification of clinical/demographic variables of interest +- support with identifying or building codelists on [opencodelists.org](https://www.opencodelists.org/) +- help with navigating [docs.opensafely.org](https://docs.opensafely.org) to find necessary documentation and policies +- help with navigating [github.com/opensafely](https://github.com/opensafely) to find helpful examples +- advice on implementing quality assurance steps +- advice on disclosure control and redaction as carried out by our output checking service +- help with troubleshooting errors when running the study locally or on the server +- coaching, advice and feedback with regards to best practice on GitHub +- communicating with the OpenSAFELY tech team on the pilot's behalf with regards to platform development + +Please note that copilots will not perform code review of any analysis scripts or review any codelists that are developed. This is because this expertise lies with the pilot and their wider research team; pilots will be advised to identify someone within their own organisation who is willing to review this component of the project. + +## What happens after the copiloting period is over (the 'post copiloting stage')? + +It is not expected that the research project will be complete at the end of the active copiloting period, rather that the pilot will have acquired the relevant experience to complete the project independently. All community resources (the [discussion forum](https://github.com/opensafely/documentation/discussions) and the `#opensafely-users` Slack channel) will remain accessible to the pilots but regular, dedicated 1:1 support for study implementation will end. The copilot will remain involved in the project over the long term in terms of output checking and manuscript review. + +As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public. See [https://docs.opensafely.org/publishing-repo/](https://docs.opensafely.org/publishing-repo/) for more information. + +## What is our authorship policy? + +Authorship should be discussed at the introductory meeting of any copiloted project. Our specific policy regarding authorship for copiloted projects is outlined below: + +- The OpenSAFELY copilot(s) for the project should always be offered authorship. Sometimes, if the copilot has needed to do a substantial amount of work to deliver a data analysis project for or with a collaborator organisation, it may be appropriate for the copilot to be offered joint first authorship (but not first). Appropriateness of joint first-authorship should be discussed with your co-pilot based on the extent of their contribution to your project. +- A core team of people who contribute to the running of the OpenSAFELY platform which facilitate every study that is completed should also be offered authorship. This includes people who contribute to the platform, code, data acquisition, data curation and management, and design of OpenSAFELY. +- In some circumstances (for example multiple consortia outputs across a diverse range of different datasets in a diverse range of different platforms with an extremely large number of contributors) it might be appropriate for some OpenSAFELY team to be authors, and others making smaller specific contributions to that single output to be listed under the group author name “The OpenSAFELY Collaborative” if the journal permits this in a manner that ensures that the individual names of members of that group author name also appear in Google Scholar and PubMed records (as is common with many journals). +- As with standard authorship guidelines, named authors must be given the opportunity to read and approve the final manuscript before submission. Persons offered authorship should also have the opportunity to decline the offer if preferred. +- A template authorship contribution form containing the named persons who should be offered authorship (and their contributions towards running the platform) can be found [here](https://docs.google.com/spreadsheets/d/1IR9EPswVzR1w224J9owyMjL_-Uao4LMpN8ntKKkE86c/edit). From d509edce9d9f31cb7bf3d4cc19daae7c41796df5 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Tue, 15 Nov 2022 12:03:00 +0000 Subject: [PATCH 02/12] Adding the copiloting documentation to the contents --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index 026122c4e..d58cbf56a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,6 +76,7 @@ nav: - Writing performant code: memory-efficient-working.md - Support: - How to get help: how-to-get-help.md + - OpenSAFELY copiloting service: copiloting-service.md - Requesting new libraries: requesting-libraries.md - Requesting study definition variables: requesting-variables.md - Updating the documentation: updating-the-docs.md From 81b46f15c6aac6b1b63bd11a3e43aebf86b7b182 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Tue, 15 Nov 2022 13:07:21 +0000 Subject: [PATCH 03/12] Adding links to introductory meeting slides and video --- docs/copiloting-service.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index e6df9fac4..9ff38047d 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -92,7 +92,9 @@ If you are unsure whether copiloting will work for your project, contact `team@o ### Assignment of copilot -Once a project has been approved, it will be matched to one of our internal OpenSAFELY researchers, in terms of the experience and knowledge required for the project. The pilot and copilot will have an introductory meeting in which the copilot will provide further details about the copiloting service and the pilot can provide further details about the research project. At this meeting, both parties will agree when the dedicated 1:1 support period will begin. +Once a project has been approved, it will be matched to one of our internal OpenSAFELY researchers, in terms of the experience and knowledge required for the project. The pilot and copilot will have an introductory meeting in which the copilot will provide further details about the copiloting service and the pilot can provide further details about the research project. At this meeting, both parties will agree when the dedicated 1:1 support period will begin. + +The slides that we use for these meetings are available [here](https://docs.google.com/presentation/d/16wAFjIPRLef3UbibSRO1R7E2GXmRohPT/edit?usp=share_link). Some of our copilots also run through a version of these slides in [this video on our Youtube channel](https://youtu.be/3BNmoV7aHwA). ### Active copiloting stage (four weeks) From 69522041d0d7a0e1b667bcbef943da8582bd47ca Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Tue, 15 Nov 2022 13:07:41 +0000 Subject: [PATCH 04/12] Updating link to authorship spreadsheet --- docs/copiloting-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 9ff38047d..d0cde885a 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -131,4 +131,4 @@ Authorship should be discussed at the introductory meeting of any copiloted proj - A core team of people who contribute to the running of the OpenSAFELY platform which facilitate every study that is completed should also be offered authorship. This includes people who contribute to the platform, code, data acquisition, data curation and management, and design of OpenSAFELY. - In some circumstances (for example multiple consortia outputs across a diverse range of different datasets in a diverse range of different platforms with an extremely large number of contributors) it might be appropriate for some OpenSAFELY team to be authors, and others making smaller specific contributions to that single output to be listed under the group author name “The OpenSAFELY Collaborative” if the journal permits this in a manner that ensures that the individual names of members of that group author name also appear in Google Scholar and PubMed records (as is common with many journals). - As with standard authorship guidelines, named authors must be given the opportunity to read and approve the final manuscript before submission. Persons offered authorship should also have the opportunity to decline the offer if preferred. -- A template authorship contribution form containing the named persons who should be offered authorship (and their contributions towards running the platform) can be found [here](https://docs.google.com/spreadsheets/d/1IR9EPswVzR1w224J9owyMjL_-Uao4LMpN8ntKKkE86c/edit). +- A template authorship contribution form containing the named persons who should be offered authorship (and their contributions towards running the platform) can be found [here](https://docs.google.com/spreadsheets/d/1-piPlxWtp1RbhQ5l7AGPrE8nLTzDIavPB1MG9bZPBfM/edit?usp=share_link). From 6e0b317f67c4ec272c17ea5d79738a3bd380404d Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Tue, 15 Nov 2022 13:30:16 +0000 Subject: [PATCH 05/12] Fixing mermaid diagram --- docs/copiloting-service.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index d0cde885a..c142efdf6 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -34,7 +34,6 @@ graph TD application_submission --> application_approval getting_started[Completing Getting Started guide] end - subgraph assignment_stage[" "] copilot_assignment[Assignment of copilot] introductory_meeting[Introductory meeting] @@ -56,32 +55,16 @@ graph TD manuscript_review[Manuscript review] output_checking_post[Output checking] end - getting_started --> assignment_stage application_approval --> assignment_stage introductory_meeting --> copiloting_stage copiloting_stage --> post_copiloting_stage - style setup_stage fill:#f7fcb9,stroke:#AAA,stroke-width:4px style assignment_stage fill:#addd8e,stroke:#333,stroke-width:4px style copiloting_stage fill:#31a354,stroke:#333,stroke-width:4px style post_copiloting_stage fill:#fff,stroke:#333,stroke-width:4px ``` -```mermaid -graph LR - subgraph key[" "] - setup_key["Application and setup stage"] - assignment_key["Assignment stage"] - copiloting_key["Active copiloting stage"] - post_copiloting_key["Post copiloting stage"] - end - style setup_key fill:#f7fcb9,stroke:#AAA,stroke-width:4px - style assignment_key fill:#addd8e,stroke:#333,stroke-width:4px - style copiloting_key fill:#31a354,stroke:#333,stroke-width:4px - style post_copiloting_key fill:#fff,stroke:#333,stroke-width:4px -``` - ### Project application and software setup All projects need to have sought and been granted [IG approval](https://www.opensafely.org/policies-for-researchers/) before a copilot can be requested and assigned. We also ask that new users complete the OpenSAFEELY [Getting Started guide](https://docs.opensafely.org/en/latest/getting-started/) to ensure that the necessary software can be installed and run on your computer. From 0d23bf7342108919f1fc81b95cf2e0fc200a9b72 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Wed, 7 Dec 2022 09:24:23 +0000 Subject: [PATCH 06/12] Improving link text --- docs/copiloting-service.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index c142efdf6..550aa99c6 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -90,8 +90,8 @@ Copilots will provide up to five days over the four weeks to support the develop - support with the construction of the required patient cohort - support with the identification of clinical/demographic variables of interest - support with identifying or building codelists on [opencodelists.org](https://www.opencodelists.org/) -- help with navigating [docs.opensafely.org](https://docs.opensafely.org) to find necessary documentation and policies -- help with navigating [github.com/opensafely](https://github.com/opensafely) to find helpful examples +- help with navigating [the OpenSAFELY documentation](https://docs.opensafely.org) to find necessary documentation and policies +- help with navigating [the OpenSAFELY GitHub repository](https://github.com/opensafely) to find helpful examples - advice on implementing quality assurance steps - advice on disclosure control and redaction as carried out by our output checking service - help with troubleshooting errors when running the study locally or on the server @@ -104,7 +104,7 @@ Please note that copilots will not perform code review of any analysis scripts o It is not expected that the research project will be complete at the end of the active copiloting period, rather that the pilot will have acquired the relevant experience to complete the project independently. All community resources (the [discussion forum](https://github.com/opensafely/documentation/discussions) and the `#opensafely-users` Slack channel) will remain accessible to the pilots but regular, dedicated 1:1 support for study implementation will end. The copilot will remain involved in the project over the long term in terms of output checking and manuscript review. -As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public. See [https://docs.opensafely.org/publishing-repo/](https://docs.opensafely.org/publishing-repo/) for more information. +As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public (see [our documentation](https://docs.opensafely.org/publishing-repo/) for more information). ## What is our authorship policy? From 9da43cf2ca94c3f7e1020f4a07f7381981f3c4d3 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Wed, 7 Dec 2022 11:49:13 +0000 Subject: [PATCH 07/12] Adding information about NHSE review --- docs/copiloting-service.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 550aa99c6..0e2c23c3f 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -104,7 +104,9 @@ Please note that copilots will not perform code review of any analysis scripts o It is not expected that the research project will be complete at the end of the active copiloting period, rather that the pilot will have acquired the relevant experience to complete the project independently. All community resources (the [discussion forum](https://github.com/opensafely/documentation/discussions) and the `#opensafely-users` Slack channel) will remain accessible to the pilots but regular, dedicated 1:1 support for study implementation will end. The copilot will remain involved in the project over the long term in terms of output checking and manuscript review. -As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public (see [our documentation](https://docs.opensafely.org/publishing-repo/) for more information). +All OpenSAFELY outputs require approval from NHS England before they can be disseminated any wider than the pilot's research group. This includes academic manuscripts (pre-printed or peer-reviewed), conference abstracts and presentations, internal reports and masters/PhD theses. Our IG team will handle the NHS England approval process; for more information about how to request NHS England approval and what to include in your publication text please see [this section of our documentation](https://www.opensafely.org/policies-for-researchers/). + +As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public (see [this section of our documentation](https://docs.opensafely.org/publishing-repo/) for more information). ## What is our authorship policy? From 13d09131ab04fbf0473d0341af14a32892629d61 Mon Sep 17 00:00:00 2001 From: Tom O'Dwyer Date: Mon, 12 Dec 2022 11:10:50 +0000 Subject: [PATCH 08/12] Fix mermaid graph styling --- docs/copiloting-service.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 0e2c23c3f..e26102df7 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -8,7 +8,7 @@ The service includes: - dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform - community support via GitHub forums and the #opensafely-users Slack channel - GitHub introduction and coaching -- output checking service +- output checking service - manuscript review - opportunities to present at quarterly OpenSAFELY User Group meetings @@ -27,7 +27,7 @@ By the end of the 4 week period, pilots should: The diagram below illustrates how a project will progress through the copiloting service. More information about each stage is provided in subsections below. ```mermaid -graph TD +flowchart TD subgraph setup_stage[" "] application_submission[Project application] application_approval[Project approval] @@ -59,10 +59,15 @@ graph TD application_approval --> assignment_stage introductory_meeting --> copiloting_stage copiloting_stage --> post_copiloting_stage - style setup_stage fill:#f7fcb9,stroke:#AAA,stroke-width:4px - style assignment_stage fill:#addd8e,stroke:#333,stroke-width:4px - style copiloting_stage fill:#31a354,stroke:#333,stroke-width:4px - style post_copiloting_stage fill:#fff,stroke:#333,stroke-width:4px + style setup_stage fill:#f7fcb9,stroke:#aaa + style assignment_stage fill:#addd8e,stroke:#333 + style copiloting_stage fill:#31a354,stroke:#333 + style dedicated_support color:white + style active_copiloting color:white + style wider_support color:white + style wider_support_details color:white + style output_checking color:white + style post_copiloting_stage fill:#fff,stroke:#333 ``` ### Project application and software setup @@ -100,9 +105,9 @@ Copilots will provide up to five days over the four weeks to support the develop Please note that copilots will not perform code review of any analysis scripts or review any codelists that are developed. This is because this expertise lies with the pilot and their wider research team; pilots will be advised to identify someone within their own organisation who is willing to review this component of the project. -## What happens after the copiloting period is over (the 'post copiloting stage')? +## What happens after the copiloting period is over (the 'post copiloting stage')? -It is not expected that the research project will be complete at the end of the active copiloting period, rather that the pilot will have acquired the relevant experience to complete the project independently. All community resources (the [discussion forum](https://github.com/opensafely/documentation/discussions) and the `#opensafely-users` Slack channel) will remain accessible to the pilots but regular, dedicated 1:1 support for study implementation will end. The copilot will remain involved in the project over the long term in terms of output checking and manuscript review. +It is not expected that the research project will be complete at the end of the active copiloting period, rather that the pilot will have acquired the relevant experience to complete the project independently. All community resources (the [discussion forum](https://github.com/opensafely/documentation/discussions) and the `#opensafely-users` Slack channel) will remain accessible to the pilots but regular, dedicated 1:1 support for study implementation will end. The copilot will remain involved in the project over the long term in terms of output checking and manuscript review. All OpenSAFELY outputs require approval from NHS England before they can be disseminated any wider than the pilot's research group. This includes academic manuscripts (pre-printed or peer-reviewed), conference abstracts and presentations, internal reports and masters/PhD theses. Our IG team will handle the NHS England approval process; for more information about how to request NHS England approval and what to include in your publication text please see [this section of our documentation](https://www.opensafely.org/policies-for-researchers/). From daf7c03f6fab8a6a64f902cdd6c233110205f32e Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Mon, 16 Jan 2023 15:53:52 +0000 Subject: [PATCH 09/12] Text updates following review --- docs/copiloting-service.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 0e2c23c3f..58d079534 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -5,6 +5,7 @@ All new users of the OpenSAFELY platform are offered access to our copilot service, which pairs the new user (the "pilot") with an experienced OpenSAFELY researcher (the "copilot") to help with the onboarding process. The objective of this service is to help new users get up and running with OpenSAFELY as quickly as possible and aims to facilitate the generation of analytical outputs from real data within a four week period. The service includes: + - dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform - community support via GitHub forums and the #opensafely-users Slack channel - GitHub introduction and coaching @@ -69,7 +70,7 @@ graph TD All projects need to have sought and been granted [IG approval](https://www.opensafely.org/policies-for-researchers/) before a copilot can be requested and assigned. We also ask that new users complete the OpenSAFEELY [Getting Started guide](https://docs.opensafely.org/en/latest/getting-started/) to ensure that the necessary software can be installed and run on your computer. -In our experience, copiloting is most successful when the pilot has some experience with coding (e.g., Python, R or Stata), is familiar with collaborative code development via GitHub and is able to commit four weeks or more to their project. +In our experience, copiloting is most successful when the pilot has some experience with coding (e.g., Python, R or Stata), is familiar with collaborative code development via GitHub and is able to commit four weeks or more to their project. However, we have had people with the required motivation and enthusiasm, and an existing adjacent skillset, to get results within four weeks. If you are unsure whether copiloting will work for your project, contact `team@opensafely.org` or use the [contact form on our website](https://www.opensafely.org/contact/). @@ -106,8 +107,6 @@ It is not expected that the research project will be complete at the end of the All OpenSAFELY outputs require approval from NHS England before they can be disseminated any wider than the pilot's research group. This includes academic manuscripts (pre-printed or peer-reviewed), conference abstracts and presentations, internal reports and masters/PhD theses. Our IG team will handle the NHS England approval process; for more information about how to request NHS England approval and what to include in your publication text please see [this section of our documentation](https://www.opensafely.org/policies-for-researchers/). -As with all OpenSAFELY projects, once a copiloted project is finished, published or it reaches its 1 year anniversary, the associated GitHub repository (and Jobserver outputs) need to be made public (see [this section of our documentation](https://docs.opensafely.org/publishing-repo/) for more information). - ## What is our authorship policy? Authorship should be discussed at the introductory meeting of any copiloted project. Our specific policy regarding authorship for copiloted projects is outlined below: From 91a52936a3a81169937c55745f299ae2de9b112f Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Mon, 16 Jan 2023 15:57:20 +0000 Subject: [PATCH 10/12] Adding signposting in final section Adding a final section that points to the Policies for Researchers page and also provides an email address that people can use to get in touch. --- docs/copiloting-service.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 58d079534..8bcfe2f01 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -116,3 +116,7 @@ Authorship should be discussed at the introductory meeting of any copiloted proj - In some circumstances (for example multiple consortia outputs across a diverse range of different datasets in a diverse range of different platforms with an extremely large number of contributors) it might be appropriate for some OpenSAFELY team to be authors, and others making smaller specific contributions to that single output to be listed under the group author name “The OpenSAFELY Collaborative” if the journal permits this in a manner that ensures that the individual names of members of that group author name also appear in Google Scholar and PubMed records (as is common with many journals). - As with standard authorship guidelines, named authors must be given the opportunity to read and approve the final manuscript before submission. Persons offered authorship should also have the opportunity to decline the offer if preferred. - A template authorship contribution form containing the named persons who should be offered authorship (and their contributions towards running the platform) can be found [here](https://docs.google.com/spreadsheets/d/1-piPlxWtp1RbhQ5l7AGPrE8nLTzDIavPB1MG9bZPBfM/edit?usp=share_link). + +## Where can I find out more? + +You can read more about how external projects are run on our [Policies for Researchers page](https://www.opensafely.org/policies-for-researchers/#acknowledgment-and-data-sharing--publication-policy). Alternatively, send us an email at [team@opensafely.org](mailto:team@opensafely.org) to start a conversation! From 272fac9d182f5a1f2fe5a372228ae7871ee75633 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Fri, 20 Jan 2023 13:46:36 +0000 Subject: [PATCH 11/12] Clarifying when the 1:1 support occurs --- docs/copiloting-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index 9b0caff1a..b0fb85b37 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -6,7 +6,7 @@ All new users of the OpenSAFELY platform are offered access to our copilot servi The service includes: -- dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform +- five days (over four weeks) of dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform - community support via GitHub forums and the #opensafely-users Slack channel - GitHub introduction and coaching - output checking service From 18230dc03649d431b63b36e5511f6cd4ac0d8e18 Mon Sep 17 00:00:00 2001 From: LisaHopcroft <54442530+LisaHopcroft@users.noreply.github.com> Date: Fri, 20 Jan 2023 13:49:00 +0000 Subject: [PATCH 12/12] Even more clarification (!) about the initial four week period --- docs/copiloting-service.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/copiloting-service.md b/docs/copiloting-service.md index b0fb85b37..d6d06774b 100644 --- a/docs/copiloting-service.md +++ b/docs/copiloting-service.md @@ -4,11 +4,10 @@ All new users of the OpenSAFELY platform are offered access to our copilot service, which pairs the new user (the "pilot") with an experienced OpenSAFELY researcher (the "copilot") to help with the onboarding process. The objective of this service is to help new users get up and running with OpenSAFELY as quickly as possible and aims to facilitate the generation of analytical outputs from real data within a four week period. -The service includes: +The service includes five days (over four weeks) of dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform and advise with regards to Github. -- five days (over four weeks) of dedicated 1:1 support with cohort extraction via the OpenSAFELY plaform +Beyond this initial four week period, we also provide: - community support via GitHub forums and the #opensafely-users Slack channel -- GitHub introduction and coaching - output checking service - manuscript review - opportunities to present at quarterly OpenSAFELY User Group meetings