Warning
This document is under development. The content may not be complete.
This chapter introduces general caIntegrator procedures and how to obtain help to use caIntegrator.
Topics in this chapter include:
About caIntegrator
NCI Center for Biomedical Informatics and Information Technology (CBIIT) is developing a novel translational informatics platform called caIntegrator that allows researchers and bioinformaticians to access and analyze subject annotation and experimental data across multiple subject annotation trials and studies. The caIntegrator framework provides a mechanism for integrating and aggregating biomedical research data and provides access to a variety of data types (e.g. Immunohistochemistry (IHC), microarray-based gene expression, SNPs, subject annotation trials data, etc.) in a cohesive fashion.
caIntegrator is a web based or locally installed portal that allows researchers and study managers to access the biomedical informatics infrastructure and data analysis tools established by caIntegrator from one common software platform. As a caIntegrator user, you can perform the following tasks:
- Integrate subject annotation data with genomic and/or imaging data
- Import data of various types in a predefined flat format, and create new studies with multiple study data
- Update an existing study to add new attributes or to add/modify data
- Perform analyses on study data
Registering as a New caIntegrator User
To request a caIntegrator account, you must register as a new user, completing the following steps:
- Go to the CBIIT caIntegrator login page or use the URL provided by your System Administrator for the caIntegrator instance at your institution.
- Click the hypertext link, under the caIntegrator login section in the upper left of the page. This opens the account registration form.
- Enter the appropriate information. Items with an asterisk or highlight are required..
- Security Information
Do you have an LDAP account [a user profile with your institution] at [NCICB or your institution]?
If Yes, enter your username and case-sensitive password for the purposes of verifying that it is correct. After you submit your request, you can continue to use caIntegrator without an account to browse and search available experiments and download data while your account is verified and activated.
**-–Username
**-–*LDAP Password
**--Requested role(s):Select one or more of the roles. Roles are described in the following table.
If your LDAP profile is not validated, caIntegrator indicates that the LDAP credentials do not check out. You are asked to reenter them, but you can choose to answer no, and the System Administrator will manually ensure you don't get a duplicate LDAP account during provisioning. You can Cancel or talk with your System Administrator about the problem.
If you select No [you do not have an LDAP account], the text boxes for entering the LDAP account information disappear. You must indicate the role you would like to be assigned in caIntegrator, and continue entering the appropriate information in the Account Details section.
Role |
Description |
Permissible Actions |
Study Manager |
Creates, owns and manages studies |
Configures and deploys studies |
Study Investigator |
Investigates and queries study data |
Queries study data |
|
|
|
- Complete the Account Details requested on the form.
- Click Submit Registration Request, or click Cancel to abort the registration.
After registration is sent, the screen displays a confirmation message.
At this point, an email containing all of the information you specified in the new user request form is sent to the caIntegrator system administrator. An account request confirmation email is also sent to you, the prospective user, at your specified email address. In response, the caIntegrator system administrator uses UPT to create your user account and assign the requested roles (in predefined groups like Study Investigator). You will recieve an email when your account is created, after which you can log in to caIntegrator.
The user ID and password you are assigned determine your access rights for the software.
Welcome to the caIntegrator Workspace
The caIntegrator Welcome workspace enables quick access to all caIntegrator functions and information before and after you login, before you open any studies.
- Welcome page that displays before and after login
Without logging in, you can browse any public studies. To do so, select from the drop-down list of public studies in the upper right-hand corner of your browser, identified in the accompanying figure.
To log into caIntegrator:logging incaIntegrator, follow these steps:
- On the login page, enter your username and password.
- Click Login. If your login is successful, the Welcome to Browse/Study page appears.
To access caIntegrator functions, use the options listed on the left sidebar of the workspace.
caIntegrator Functions
Once a study is created, its name appears at the top of the left sidebar. The following table describes each caIntegrator sidebar option in the workspace.
Sidebar Option |
Function |
||
---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d018e981-d9ba-4e88-9aaf-72e61dc7d4c8"><ac:plain-text-body><![CDATA[ |
[Study Name] |
When you log in, one study displays in the left sidebar by default. Any study that you select in the My Studies drop-down list in the upper right of the page replaces this default selection. |
]]></ac:plain-text-body></ac:structured-macro> |
Home |
Click this to return to the home page for the selected study. |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ada75db5-e673-4f7c-b7e8-ffea3afa91e3"><ac:plain-text-body><![CDATA[ |
Search [Study Name] |
Click this option to open the Search [Study Name] page from which you can launch queries into your selected study. For more information, see . |
]]></ac:plain-text-body></ac:structured-macro> |
Study Data |
Click Saved Queries > My Queries to open the list of previous queries you saved. Click any item in the list to open the saved query, which displays on the Criteria, Columns and Sorting tabs. From those tabs, you can modify criteria and/or launch the query again. For more information, see on page 62. |
||
Analysis Tools |
Click any of the listed options to open a page where you can launch an analysis of the data in the selected study.
|
||
Study Management |
Click either of the listed options to manage the selected study through editing or deleting it or by creating a new study.
|
||
Application Management |
Click Manage Platforms to identify, add or remove platforms that caIntegrator supports. For more information, see on page 47. |
||
caIntegrator Menu |
|
||
Help |
Click the Help icon at the top of each page to open a context-sensitive topic. The help page displays information (from this user's guide) that corresponds to the page from which help was opened. |
In the My Studies drop-down list in the upper right of the page, select the study you want to use for your current session. (The list includes all studies to which you are subscribed as well as public studies.) As you do so, the following left sidebar contents change to reflect options relevant to your study selection:
- the logo for the selected study (if it exists)
- the name for the selected study
- the list of saved queries and/or saved lists for that study
Viewing Existing Studies
- If you have not logged into caIntegrator, you can view any public studies in your browser.
- After logging in, you can view existing studies for which you have been granted permission. In the upper right corner of the page, in the My Studies drop down list, shown in the following figure, select the study you want to review or work in.
- Drop-down list for selecting existing studies
After selecting the study name in the My Studies drop-down list, a study summary including a status field should appear. If the status is not deployed, or if the study summary does not appear, then the study is not deployed and available for analysis.
When annotations are uploaded during the creation of the study, each field is defined by the study manager.
- Because in looking at the study, you may not know the meaning of all the annotations, you can open a reference page with a summary of the annotations. Click the Data Dictionary: View link on the study home page, as described in the following section.
- From the study summary page, you can also open a log for the study. Click the Study Log: View link on the page to see all log entries with descriptions.
Data Dictionary
A link on a study home page, as shown by the arrow in the following screen shot, opens a data dictionary summary.
The Data Dictionary table clarifies all annotations used in the study. It displays their field descriptors, descriptions, caDSR identifiers (if used), caDSR IDs and definitions, data type, and permissible settings, shown in the following figure. The Restrictions column indicates whether or not masks have been applied to numeric data in the study. For more information, see on page 23..
- Page for viewing data dictionary details
For more information about study details, see on page 17.
Study Log
The study log which you can open by clicking the Study Log > View link on the study summary page lists the steps used to create a study. For more information, see on page 18.
Logging Out
To log out of caIntegrator, click the logout link in the upper right-hand corner of the page.
Application Support
For any general information about the application, application support or to report a bug, contact NCICB Application Support.
Email: |
When submitting support requests via email, please include:
|
Application Support URL |
|
Telephone: 301-451-4384Toll free: 888-478-4423 |
Telephone support is available: |