NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised to be consistent.
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. This section includes the following topics:

Table of Contents
maxLevel3
minLevel2

...

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, the Manage Protocol page appears with the following options.

You can also perform the following functions with a protocol.

Return to top of page

...

Include Page
Saving and Submitting for Review
Saving and Submitting for Review

To create a new protocol

...

Click the Protocols caNanoLab menu option.

On the Manage Protocols page, click Create a New Protocol.

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

...

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.

...

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.

...

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

...

To clear the entries and start again, click Reset

...

When you finish defining the protocol, click Save.

Info
titleMy Workspace

Once you save a protocol, it is listed on the My Workspace page where you can manage all of your submitted protocols, and view any protocols that a user has shared with you.

...

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

  1. Update the protocol information.

Return to top of page

...

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

Info
titleUpdating data after it is Public

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.

The following table lists and describes the fields. An asterisk indicates a required field. 

...

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.

...

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

...

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

...

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

...

Click Update when you are done editing the Protocol. To disregard the changes, click Reset.

Return to top of page

...

Return to top of page

...

Return to top of page

...

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

To launch a search for a specific protocol

...

Click the Protocols menu.
The Manage Protocols page displays.

...

Click Search Existing Protocols in the Sample Links panel.

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.

The Protocol Search page displays.

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

This chapter describes how to manage protocols in caNanoLab with the Protocols function. 

Panel
borderColorsilver
borderStylesolid
titleContents of This Chapter

Page Tree
expandCollapseAlltrue
root@self
startDepth2
searchBoxtrue

...

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.

 

To clear the values and start again, click Reset to clear the search criteria.

...

Click Search to launch the search.

Return to top of page

...

Once you submit a search for a protocol, search results show pertinent protocol information defined in Creating a Protocol.

Info
titleNote

The number of items located in the search display appears in the the upper-left of the search results table. The bottom right of the search results table enables you to navigate to pages.

To return to the Search page, click the Back ( Back ButtonImage Removed ) button, not the Browser button.

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

...

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

Info
titleNote:

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.

...

Return to top of page

...

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 Edit in the first column of the the Protocol Search Results page. The Update Protocol page opens. From the Update Protocol page, click Delete in the lower-left corner of the window. Confirm the deletion.

Return to top of page

...

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 protocol search.
  2. From the search results, find the protocol that you want to bookmark. Click + Add to Favorites in the first column of the Protocol Search Results row.
    Bookmarking a protocol from search resultsImage Removed
    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 of page

...