Section 1 - Prerequisites

Complete the prerequisites listed below prior to registering donors and samples or uploading any data. Click the provided links in this section to go to related portals or websites, or to access additional relevant information.

Register as a member, which includes requesting access to resources, completing any required agreements, and verifying your access.

  1. Request access to portals (or other resources you will need):
  2. Submit preliminary documentation:
  3. Complete onboarding for your consortium.

Register experimental protocols for your group:

  1. Register experimental protocol(s) via protocols.io. Note: Each registered protocol requires a digital object identifier (DOI).
    • Initial setup
      • Select a lead and create accounts.
      • Create a workspace for your team (TMC, TTD, RTI, DP, etc).
    • Organize your protocols
      • Break workflows into modules.
      • Create an overall protocol that references others.
      • See this Vanderbilt protocol as an example: VU BIOMIC Kidney pipeline
    • Create / Publish a New protocol
    • Modify an existing protocol
      • Open an existing protocol.
      • Use Edit New Version or Edit New Fork.
      • For detailed directions, click on “Details about Creating (or Publishing) Protocols…“ or related sections below.

Note: There are three different types of protocols required.

Different ways to create a New Protocol

  1. Create an entirely new protocol from “scratch” at protocols.io.
  2. Create a new version of an existing protocol:
    • Based on an existing protocol that you created.
    • Based on an existing protocol that someone else created.


Details about Creating New Protocols

Creating an entirely new protocol (from "scratch"):

1. **Log into protocols.io** Using your protocols.io login registered with your consortium. 2. **Select your Workspace:** - Click the HuBMAP icon for the HuBMAP Workspace - Click the SenNet icon for the SenNet Workspace - If you do not see your icon you have not been added to the group - Contact your helpdesk for assistance. 3. **Click the NEW + button** at the top and select **New protocol**. 4. **Select a template option:** - There are several template options for a protocol. - The option selected determines the tool widgets shown on the right. 5. **Rename the protocol** from “untitled protocol” to something more descriptive so the protocol saves properly. 6. **Fill in the Details:** A series of tabs displays under the protocol title: (_Description, Guidelines..., Materials, etc._) - Fill in information for all tabs shown - Under _Description > Keywords_ enter your consortium and group (TMC, etc.) 7. **Publishing** - When you are satisfied that the protocol is complete... - Select **MORE > Publish** - Publishing is a multistep process (see below). **IMPORTANT:** Once published, a protocol cannot be deleted or edited, only versioned.
Details about Publishing Protocols ### Publishing your new protocol: 1. **Publish type** - select **With DOI**.
**IMPORTANT:** HuBMAP and SenNet protocols MUST be assigned a DOI. - This is required to register a donor (or source) and samples. - This is required to submit assay metadata to the HIVE or CODCC. 2. **Set authors** - Multiple authors may be added in order of importance. - You can drag-and-drop authors to reorder. 3. **Status** - Select _Working, In Development,_ or _Other_. 4. **Research study** - Select _Research_ (most likely) or _Non-Research_. 5. **Add workspaces** - _Show_ and _Share_ the protocol on the HuBMAP (or SenNet) Workspace. - You can also show or share the protocol on any other workspace, if desired. 6. **Publish** - Publish the protocol.
Updating a protocol you created ### Revise a Protocol you created previously 1. **Navigate to the protocol** on [protocols.io](http://protocols.io/). - Click on the protocol to select it. 2. Select **New Version > Create New Version > Edit New Version**. 3. **Re-publish** - Make any changes needed and republish the protocol. - The process is virtually identical to the Create a new Protocol process.
Updating a protocol someone else created ### Create a new protocol based on someone else's Protocol 1. **Navigate to the protocol** on [protocols.io](http://protocols.io/). - Click on the protocol to select it. 2. Select **Copy/Fork > Make a Fork** - Select where to store the copied protocol - Select **Edit New Fork** 3. **Re-publish** - Make any changes needed and republish the protocol. - The process is virtually identical to the Create a new Protocol process.