NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{scrollbar:icons=false}

Page info
title
title

 This chapter describes how to manage protocols in caNanoLab with the Protocols function. This section includes the following topics:

Table of Contents
minLevel2

Protocols Overview

The Protocols function enables you to create or search for a protocol. A protocol provides clear and detailed documentation about the precise actions taken in creating or annotating a sample. When you click the Protocols option on the caNanoLab menu bar, the Manage Protocol Home page appears. The Protocol links on the Manage Protocol Home page provide the following options:

Description of a Protocol

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.

...

Info
titleVisibility option

If you do not select an option for visibility, by default, Private is selected, meaning only the owner can view and/or modify it.

Submitting a Protocol

To submit a new protocol:

  1. Click the Protocols caNanoLab menu option. On the Manage Protocols Home page, click the Submit a New Protocol link. This opens the Submit Protocol form.

    Tip

    Include Page
    Other options
    Other options

  2. The following table lists and describes the fields on the Submit a Protocol page. Enter and select the appropriate information as needed. Items with an asterisk are required fields.

    NameDescription

    Protocol Type*

    Include Page
    Protocol type
    Protocol type

    Protocol Name*

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

    Protocol Abbreviation

    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 the Browse button 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 ProtocolFor more information, see 2 - Managing Protocols in caNanoLab 2.1 DRAFT Sharing and Changing Access to a Protocol.

    To clear the entries and start again, click the Reset button.

  3. When you finish defining the protocol, click the Submit button.

Editing a Protocol

You can edit a sample using the following techniques:

Updating a Protocol

The Protocol Update page opens when you click the Edit link corresponding to a protocol listed in 2 - Managing Protocols in caNanoLab 2.1 DRAFT. Protocol Search Results. The page displays all of the information for a protocol that was entered when the protocol was created in caNanoLab (2 - Managing Protocols in caNanoLab 2.1 DRAFTSubmitting a Protocol). With appropriate permissions, you can edit the title, description and visibility of a protocol in this dialog box.

...

Update SampleDescription

Protocol Type*

Include Page
Protocol type
Protocol type

Protocol Name*

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

Protocol Abbreviation

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 the Browse button to navigate to the protocol to be associated with the protocol, or enter the URL where the protocol is located.

Protocol Abbreviation

Shortened phrase used in place of the protocol name.

File Title The title of the Protocol file.
Description

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

Access to the ProtocolFor more information, see 2 - Managing Protocols in caNanoLab 2.1 DRAFT Sharing and Changing Access to a Publication.

Sharing and Changing Access to a Protocol

Is this option limited to curator's only?

Include Page
Sharing
Sharing

Deleting a Protocol

Info
titleNote

This action deletes the protocol from the caNanoLab database, executed behind the scenes at a scheduled time.

To delete a protocol, perform a search, find the protocol that you want to delete, and click the Edit link in the first column of the the 2 - Managing Protocols in caNanoLab 2.1 DRAFT Protocol Search Results page. The Update Protocol page opens. From the Update Protocol page, click the Delete button in the lower-left corner of the window. Confirm the deletion.

Anchor
SearchProtocols
SearchProtocols
Searching Existing Protocols

You can access this page after logging into caNanoLab or you can access publicly available sample protocols from the Login page.

...

  1. Click the Protocols caNanoLab menu option. On the Manage Protocols Home page, click the Search Existing Protocols link. This opens the Search Protocols form.

    Info
    titleNote

    When defining search criteria, there are no "required" fields. You can add only those parameters that you consider essential to the search. If you do not define any search criteria, all the protocols will be found.

  2. The following table lists and describes the fields. Enter text or select criteria as appropriate.

    NameDescription

    Protocol Type

    Include Page
    Protocol type
    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 that has been assigned to the protocol.

    Protocol File Title

    Enter the name of the protocol file title

  3. Click Search to launch the search.
    To clear the values and start again, click Reset to clear the search criteria.

Protocol Search Results

Once you submit a search for a protocol (2 - Managing Protocols in caNanoLab 2.1 DRAFTSearching Existing Protocols), search results display in the caNanoLab screen. Results show pertinent protocol information defined which is defined in the 2 - Managing Protocols in caNanoLab 2.1 DRAFT Submitting a Protocol section. Columns are sortable by page by clicking on the column heading.

...

Sample Search Results ColumnsDescription
Action

Click View in the first column to display the protocol on the 2 - Managing Protocols in caNanoLab 2.1 DRAFT. Updating a Protocol.

Info
titleNote:

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

Click the + Add to Favorites link 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.

Info
titleNote

If the protocol is already added as a Favorite, clicking + Add to Favorites displays the <protocol name> has already been added to your favorites message.

Protocol Type

Include Page
Protocol type
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

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 sample was added.

Adding a Protocol to My Favorites

My Favorites displays samples, protocols, and publications that you bookmark for quick access.

...

  1. Perform a protocol search.
  2. Find the protocol that you want to bookmark and click the + Add to Favorites link in the first column of the 2 - Managing Protocols in caNanoLab 2.1 DRAFT Protocol Search Results row.
    The Added to Favorites message appears in the results row.
  3. Click the My Favorites option in the menu bar, and the bookmarked protocol will be listed under My Protocols.

...