Performing a caNanoLab Keyword Search | caNanoLab User's Guide| Managing Samples in caNanoLab

This chapter describes how to manage protocols in caNanoLab with the Protocols function. Topics in this chapter include:

Protocols Overview

During a caNanoLab workflow, you can identify a protocol used in creating or annotating a sample. A protocol provides clear and detailed documentation about the precise actions taken in any procedure that might be part of an experiment. For example, a protocol could describe the steps a laboratory used for characterizing samples. There are different type of protocols, such as Physical, In Vitro, and In Vivo.

With every protocol object you create in caNanoLab, you can define its visibility, in other words, its access to other users of caNanoLab. For more information about visibility options, see the tables corresponding to each characterization type.

When you click the Protocols menu, Manage Protocol appears with the following options.

You can also perform the following functions with a protocol.

Return to top

Creating a Protocol

To create a new protocol

  1. Click the Protocols menu.

    Manage Protocols displays.

  2. Click Create a New Protocol.

  3. From Create Protocol, fill in the following information as needed.

    NameDescription

    Protocol Type*

    Protocol Name*

    Enter or select from the drop-down list the protocol name (required).

    Protocol Abbreviation

    Enter a shortened phrase used in place of the protocol name.

    Protocol Version

    Enter or select from the drop-down list the protocol version number.

    Upload
    OR
    Enter File URL

    Click Browse to navigate to the protocol to be associated with the protocol, or enter the URL where the protocol is located.

    File Title

    Enter the title of the protocol file.

    Description

    Enter any additional description information that the form does not include.

    Access to the Protocol

    For more information about sharing, see Sharing a Protocol with a User or Group or Making the Protocol Public.

  4. Click Save.

    After saving, the protocol is listed on My Workspace where you can manage all of your saved protocols, and view any protocols that a user has shared with you.

  5. Once you save the protocol, Update Protocol opens. With the appropriate security permissions you can

    1. Update the protocol information.

Return to top

Updating a Protocol

Update Protocol enables you to update protocol information and update access to the protocol.

Once data is made Public, you can update the data, but it will be retracted from Public, and you will need to resubmit it to the curator again for review.

  1. From Update Protocol, fill in the following information as needed.

    Update SampleDescription

    Protocol Type*

    Protocol Name*

    Enter or select from the drop-down list the protocol name (required).

    Protocol Abbreviation

    Enter a shortened phrase used in place of the protocol name.

    Protocol Version

    Enter or select from the drop-down list the protocol version number.

    Upload
    OR
    Enter File URL

    Click Browse to navigate to the protocol to be associated with the protocol, or enter the URL where the protocol is located.

    File TitleThe title of the protocol file.
    Description

    Enter any additional description information that the form does not include.

    Access to the Protocol
  2. Click Update when you are done editing the Protocol.

Return to top

Sharing a Protocol with a User or Group

Return to top

Making a Protocol Public

Return to top

Searching Existing Protocols

To launch a search for a specific protocol

  1. Click the Protocols menu.
    Manage Protocols displays.

  2. Click Search Existing Protocols.

  3. From Protocol Search, fill in the following search criteria as needed.

    NameDescription

    Protocol Type

    Protocol Name

    Enter a partial or complete name of the protocol. Select Contains (for partial text) or Equals (for an exact search) from the dropdown list.

    Protocol Abbreviation

    Enter a partial or complete name of an abbreviation assigned to the protocol.

    Protocol File Title

    Enter the name of the protocol file title.

  4. Click Search.
    Protocol Search Results opens.

Return to top

Protocol Search Results

Once you submit a search for a protocol, search results show pertinent protocol information defined when creating a protocol.

The following table lists and describes each column of the search results.

Sample Search Results ColumnsDescription
Action

Click View in the first column to display the protocol in a PDF file.

Edit is only available for people that have an account and are logged into the system and are associated with the protocol.

Click + Add to Favorites to add a bookmark for the protocol on your My Favorites tab. Added to Favorites appears in the column when the protocol is successfully added.

Protocol Type

Protocol Name

Enter or select from the drop-down list the protocol name.

Protocol Version

Enter or select from the drop-down list the protocol version number.

Protocol Abbreviation

Enter a shortened phrase used in place of the protocol name.

Protocol File

The Title and Description of the protocol are listed. Click View to download the protocol file.

The column is empty when there is no protocol file associated with the Protocol.

Created DateIndicates the date on which the protocol was added.

Return to top

Deleting a Protocol

Delete removes the protocol from the caNanoLab database, executed behind the scenes at a scheduled time.

To delete a protocol

  1. Perform a search.
  2. On the search results, click Edit in the Actions column.
  3. From Update Protocol, click Delete in the lower-left corner of the window.
  4. Confirm the deletion.

Return to top

Bookmarking a Protocol to My Favorites

The caNanoLab My Favorites menu option displays samples, protocols, and publications that you bookmark for quick access.

To add a protocol to My Favorites

  1. Perform a search.
  2. On the search results, click + Add to Favorites in the Actions column.
    Bookmarking a protocol from search results
    The Added to Favorites message appears in the results row.
  3. Click the My Favorites menu, and the bookmarked protocol is listed under My Protocols.

Return to top

Performing a caNanoLab Keyword Search | caNanoLab User's Guide| Managing Samples in caNanoLab