Update docs/protocols/protocols_guide_internal-how-1.md
Compare changes
@@ -30,7 +30,7 @@ nav_order: 2
@@ -30,7 +30,7 @@ nav_order: 2
Your scanning procedure file (.doc) and scanner protocol (.pdf) will be given to you by your radiographer at the start of your project. You will be provided with a new version if there are changes in the protocol. You can request copies of these files by emailing radiographers@win.ox.ac.uk with your calpendo project number.
Your scanning procedure file (.doc) and scanner protocol (.pdf) will be given to you by your radiographer at the start of your project. You will be provided with a new version if there are changes in the protocol. You can request copies of these files by emailing radiographers@win.ox.ac.uk and providing your calpendo project number.
### 1.2 Request permission from the radiographer author of the scanning procedure to add them as an author on the public doi record of your protocol.
The radiographer author of your scanning procedure is listed at the top of the file. Contact this radiographer and ask their permission to be listed as a contributor to this protocol on the public doi record. Request the radiographers ORCID ID for inclusion.
@@ -77,61 +77,59 @@ Protocols are saved to individual user profiles.
@@ -77,61 +77,59 @@ Protocols are saved to individual user profiles.
If the uploaded file is recognised as a sequence pdf, you should see the `Register Protocol` page. If the file is not in the right format, you will see an error. Please check the file you have selected is a pdf of your MR protocol.
You can enter details about your protocol which are relevant to the study as a whole, or all sequences. These details are entered at the top of your protocol. These details will help future users understand your decisions or implement your protocol.
NOTE: If you are publishing custom pulse sequences, please be sure to indicate your willingness and requirements for shring the pulse sequence (see [3.4.1 Custom Sequences](#3-4-1-custom-sequences) below).
Some fields of this section are identified by the database from your pdf. Others have to be selected by you. Complete the following selections by selecting the appropriate item from the dropdown menus.
Keywords can be used by users to find your protocol. Note that when users are searching for a protocol, their search query will be matched to keywords only, not text in the body of the entry.
This section should identify and highlight important features of the protocol. For example the study design, methods, and procedure. The Radiographers procedure abstract is sufficient.
This section should provide high-level instructions for use of this protocol. Where possible, we recommend including the following:
1. **Contact details** for anyone looking to discuss re-use of the project. Note this information will be publicly available if your protocol is made public. Only include contact details where explicit permission has been granted.
2. **How to cite** this entry, including any references you would like to be cited in addition to this entry (see [Issuing a doi and licence](#issuing-a-doi-and-license) below).
3. **Your terms for reuse** (see [Issuing a doi and licence](#issuing-a-doi-and-license) below), including any specific terms around authorship before others reuse this protocol. For example, "We request that future users of this protocol contact the authors of this entry to discuss collaboration and authorship agreements relating to reuse." This may be particularly relevant for experimental protocols or sequences.
3. **Your terms for reuse** (see [Issuing a doi and licence](#issuing-a-doi-and-license) below) including any specific terms around authorship before re-using this protocol for example: "We request that future users of this protocol contact the authors to discuss collaboration and authorship agreements related to the reuse". This may be particularly relevant for experimental protocols or sequences.
You may also like to include some practical guidance, such as the total length of the scanning session, staffing levels, or any peripheral equipment. You may refer the reader to the radiographers procedure file if this is to be attached (see [4. Attachments](#4-attachments)).
You should also highlight non-standard software or sequence requirements, such as custom pulse sequences (see [3.4.1 Custom Sequences](#3-4-1-custom-sequences)).
If you are publishing protocol which uses a custom pulse sequence, please make it clear whether you are happy to also share the sequence.
"This protocol uses a user written custom pulse sequence. The author of the pulse sequence is willing to share it with other labs provided:
- The lab/hospital has the appropriate contracts in place with Siemens and idea licence that allow custom pulse sequences to be installed on their system.
- We have a version that is available for your platform [(e.g. we currently can only supply for VB11C and VB11E)]
- You are willing to arrange for a sequence transfer agreement between Oxford University and your institution to be signed.
If all of the above apply then please contact [email address if the PI] in the first instance. Please note that neither Siemens nor Oxford University make no commitment to support this transfer."
"This protocol uses a user written custom pulse sequence. We do not have the resources to share the sequence with other labs, so the protocol is provided for your information only."
Browse to and add any attachments to support the implementation of your protocol. This should ideally include the (redacted) radiographers procedure. You may additionally choose to attach analysis of pilot data, for example.
@@ -139,7 +137,7 @@ Browse to and add any attachments to support the implementation of your protocol
@@ -139,7 +137,7 @@ Browse to and add any attachments to support the implementation of your protocol
You can add details specific to individual sequences. These details may make it easier for users of this protocol to understand the outputs if the protocol is run. You can include information about why these sequences where chosen or refer to decisions made during pilotting. You may reference back to earlier versions of the protocol entry to indicate changes where appropriate.
You can add details specific to individual sequences. These details may make the understanding of the outputs easier for other users. You can include information about why these sequences where chosen or refer to decisions made during piloting. You may reference back to earlier versions of the protocol entry to indicate changes where appropriate.
@@ -149,37 +147,37 @@ Each of the sections below should be completed for each sequence.
@@ -149,37 +147,37 @@ Each of the sections below should be completed for each sequence.
The sequence description provides key features that might help someone choose whether it meets their needs. For example, “A standard T1-weighted structural scan, of 1mm isotropic resolution, suitable for registration to a standard template in an FMRI protocol".
It may additionally be useful to disambiguate any abbreviations in the name of the sequence, for example "bold_mbep2d_MB4P2_task_faces" could be described as "multiband 2D echoplanar sequence; multiband acceleration factor 4, PAT (GRAPPA) factor 2; for faces task.".
Where a specific task is mentioned, you could link to where that task is shared, or published analysis of any data using that task.
Consider adding specific purpose and pros/cons of the sequence. For example, one sequence has a high temporal resolution but relatively low spatial resoltuion. Or one sequence is developed to focus on a specific brain area. Cons may include dropout or poor signals from certain regions.
Once all required fields have been completed, you will be able to save the entry to the protocols database. Press `Save` to progress to return to the list of your protocols.
By default, your entries will be set to `Internal (University Only)` visible when you add them to the database. This means users will be required to log into the the protocols database with an SSO in order to review or download your entry.
After they have been entered onto the database you can make individual protocols publicly visible (`Open Access`) and identify them as `WIN Recommended` protocols as appropriate.
If you choose to make a protocol public ("open access") ensure you have added a license note to your entry, reserved a doi for the protocol using zenodo, and added the doi to the usage guidance (see [Issuing a doi and licence](#issuing-a-doi-and-license) below).
If you identify a protocol as open access, this will trigger a review by database administrators. <mark>Further detail of the review process coming soon. </mark>
This field features prominently at the top of the entry when it is accessed by users, so it may be appropriate to repeat any important citation information which is listed in the usage guidance.
Add any references which are relevant to this protocol, for example the paper or pre-print which it accompanies. You can also use this space to draft the author list and track changes in contribution.
We recommend that you consider using the [CRediT](https://casrai.org/credit/) system for identifying individual author contributions. You may wish to order authors alphabetically.