KBase Documentation
  • KBase Documentation
  • KBase Terms & Conditions
  • Getting Started
    • Signing Up and Signing In
      • Step-by-Step Signup Guide
      • Authentication Update
    • Supported Browsers
    • Narrative Quick Start
    • Narrative Interface User Guide
      • Access the Narrative Interface
      • Tour the Narrative Interface
      • Narrative Navigator
      • Create a Narrative
      • Explore Data
      • Add Data to Your Narrative
      • Browse KBase Analysis Tools
      • Analyze Data Using KBase Apps
      • Job Browser
      • Revise Your Narrative
      • Format Markdown Cells
      • Share Narratives
      • Linking Static Narratives to ORCID
      • Access and Copy Narratives
      • Organizations
    • FAQs
  • Manage Your Account
    • Linking Accounts
    • Linking KBase to ORCiD
  • Working with Data
    • Data Upload and Download Guide
      • Data Types
      • Importing Data
        • Bulk Import Limitations
      • Assembly
      • Genome
      • FASTQ/SRA Reads
      • Flux Balance Analysis (FBA) Model
      • Media
      • Expression Matrix
      • Phenotype Set
      • Amplicon Matrix
      • Chemical Abundance Matrix
      • SampleSet
      • Compressed/Zipped Files
      • Bulk Import Specification
      • Downloading Data
    • Searching, Adding, and Uploading Data
    • Filtering, Managing, and Viewing Data
    • Linking Metadata
      • Ontologies and Validated Terms
    • Public Data in KBase
    • Transfer Data with Globus
  • Using Apps
    • Analysis Apps in KBase
      • Assembly & Annotation
      • Comparative Genomics
      • Metabolic Modeling
      • Metagenomics & Community Exploration
      • Data Matrices - Amplicon, Stats
      • Chemical Abundance
      • Expression & Transcriptomics
    • Apps in Beta
  • Running Common Workflows
    • Assembling & Annotating Microbial Genomes
      • FAQ: Assembly and Annotation
    • Comparative Genomics & Phylogenetic Analysis
      • FAQ: Comparative Genomics
    • Metagenomic & Community Analysis
      • FAQ: Metagenomics & Community Analysis
    • Transcriptomic Analysis
      • FAQ: RNA-seq Analysis
    • Constructing Metabolic Models
      • Constructing and Analyzing Metabolic Flux Models of Microbial Communities
      • FAQ: Metabolic Modeling
  • Community Developed Workflows and Tools
    • Functional Annotation
    • Functional and Taxonomic Profiling of MAGs
    • Taxonomy
    • Viral
    • Random Walk with Restart Toolkit
  • Troubleshooting
    • Problems with the User Interface
    • Help Board
    • How to Report Issues
    • Job Errors and Their Meanings
      • Common Job Errors
        • The Job Log
      • Import Job Errors
      • Assembly App Errors
      • Annotation App Errors
      • Functional Genomics App Errors
      • Modeling App Errors
  • Developing Apps
    • The KBase SDK
    • Create a KBase Developer Account
    • KBase GitHub Repository
  • External Links
    • KBase Narrative Interface
    • KBase web site
    • KBase App Catalog
  • kbase.us
Powered by GitBook
On this page
  • Add an App to your Narrative
  • Fill in parameters
  • Run the App
  • Conduct further analyses
  • Re-run Apps with the same or different parameters
  • Report errors

Was this helpful?

  1. Getting Started
  2. Narrative Interface User Guide

Analyze Data Using KBase Apps

PreviousBrowse KBase Analysis ToolsNextJob Browser

Last updated 1 year ago

Was this helpful?

Once exploring available and determining which ones work with the data objects in your Narrative, you can start analyzing your data.

Add an App to your Narrative

To add a KBase analysis app, find the app of interest and click its name or the icon to the left of the app name. A box (called a cell) containing the chosen app will appear in the main Narrative panel.

A few things to notice about the app cell:

App Cells have three tabs

  1. Configure (where you set the parameters; it’s what you see when you add a new app cell)

  2. Info

  3. Job Status

  4. Result

The last two tabs are filled in once you run the app; these are discussed later.

  • The up and down arrows let you move the cell up or down in your Narrative.

  • The "-/+" in the App Cell menu is the collapse/expand cell option. When the App Cell is expanded, the farthest right option will be a "-" to collapse the cell. When the App Cell is collapsed, the farthest right option will be a "+" to expand the cell. You can also double click on an App Cell to expand/collapse the app.

  • Every app has some parameters (fields) that must be filled in before you can run the app.

Fill in parameters

After you add an app to your Narrative, the required parameters must be filled in before you can run it. For most apps, you will need to select the input data object(s). Other parameters may also need to be set. A red bar to the right of a field indicates that it is a required field and you have not yet entered a valid value in it. Other indicators, such as banners for errors and warnings, may appear. Read the message and hover over any icons to reveal hints. Once you have filled or corrected the field, the indicator should disappear.

Some fields are also required, but they will be pre-filled with default values. You can change their values if you chose, or leave them. Additionally, some apps have optional “advanced options” that you can reveal by clicking on the “advanced options” link at the bottom of the cell.

The green "Run" button is enabled when all required fields are filled in.

Save Your Work

As you add to your Narrative, be sure to save your work frequently, using the Save button at the top right of the screen.

Run the App

When you have filled in all the required fields, the Run button on the left side of the app will be enabled; click it to start running the app. Once clicked, the green Run button will turn to a red Cancel button. When the analysis starts running, you will see information in the Job Status tab.

Depending on the analysis, the analysis might finish within a few seconds or could take hours to run. You can save your Narrative and come back to it later–the analysis will continue running even if you don’t have the Narrative open.

Examine and download results

When an app finishes running, you will see a summary in the Results tab, as well as an output cell below your app cell. Also, if the analysis generates a new data object, that object will be added to your Data Panel.

In the example, the “Annotate Microbial Contigs” app, once run, produced an output cell that provides information about the newly annotated Shewanella genome object.

This output cell has three tabs: Overview (displayed above), Browse Contigs, which lists the large assembled pieces of a genome, and Browse Features, which allows browsing of all the annotated genes.

In addition to creating a new output cell, the app we ran created a new data object and added it to our Narrative. The newly annotated genome object now appears at the top of the Data Panel.

Conduct further analyses

Once you have reviewed your results, you can use your newly generated data in additional analysis steps. Remember, you can click on the data object in the Data Panel to see which KBase Apps work with that data type.

Re-run Apps with the same or different parameters

App input cells that have already been run have a “Reset” button that allows you to redo the analysis, with the option to change any of the parameter settings (including, perhaps, the input data) before rerunning. Rerunning an App will overwrite the information in the App cells, but will not overwrite any data objects in your Narrative unless you use the same output object name again.

Report errors

The App “…” dropdown menu offers several options for showing the code that will execute the app; getting more info (in a separate browser window) about the app; and deleting the cell. These are discussed more in the section called ““.

Some app fields are “smart” and know which data in your Narrative is valid for that field. These “smart” fields have a pulldown list of data objects that you can choose from. (Remember, only data (of the appropriate type) that you have already added to this particular Narrative will be shown in that list. You can access your data from other Narratives via the My Data and Shared with me tabs in the .)

Different apps create different types of output cells when they run, depending on which type of data object is output by the app. The genome output cell shown above is an example of a Data Viewer. Data Viewers are described in the section of this guide.

Remember that you can hover over an object in the Data Panel and click the “..." that will appear to see more information and options, including an option (see image) for downloading the object in GenBank or JSON format (see the for more information). In the future, you will be able to choose from a wider variety of common formats, allowing you to download results to use with other tools and send to colleagues.

For example, our annotated genome can be used in a number of analyses because it now includes the standard KBase annotations. If you click on the genome in the Data Panel, you see several apps that apply. Among them are the that constructs a phylogenetic tree allowing you to see species closely related to your genome. You also can use the to draft a metabolic model from the annotated genome.

If a job fails, you will see an error message in the output cell and/or in the Result tab. If you need help figuring out what went wrong, please with details about what you were doing when the error occurred and what the error message said. Including the contents of the Job Status tab and the URL of your Narrative will help us debug the problem. We are here to help and appreciate your feedback and error reports!

Revise Your Narrative
Data Panel
Explore Data
Download Guide
Insert Genomes into Species Tree App
Build Metabolic Model App
contact us
KBase Apps