Narrative Quick Start
A fast, one-page introduction to KBase's narrative interface
Last updated
A fast, one-page introduction to KBase's narrative interface
Last updated
In KBase, you can create shareable, reproducible workflows called Narratives that include data, analysis steps, results, visualizations, and commentary. This Quick Start provides an overview of how to create and use the features of Narratives.
To begin using KBase, you will first need to Sign up for a KBase Account. You can now use your existing Google or Globus username and password to get a free KBase account.
After you sign in, you will be taken to your Narratives (details of which can be found here). From Narratives, you can open your existing Narratives, access others that have been shared with you, and create new Narratives. These Narratives can be accessed at narrative.kbase.us.
If you are a new user, your 'My Narratives' and 'Shared With Me' will likely be empty, since you haven’t created any Narratives yet.
Click the “+ New Narrative” button in Narratives to open a new untitled Narrative. A “Welcome to the Narrative Interface” box offers information and links to documentation for adding content to your Narrative. You can collapse or delete this box using the “…” dropdown menu in the top right corner.
Try the Narrative tour!
Select the “Narrative Tour” from the Help menu. This new feature walks you through the user interface, pointing out various useful aspects of it. We recommend taking the tour even if you’ve used KBase before, as it will help familiarize you with the current version.
To load data to your Narrative, click the “Add Data” button in the Data Panel, which can be found under the Analyze tab near the top left of the Narrative. The Data Browser will slide out with tabs that show several data sources.
You can choose a dataset already in KBase. The Example tab, for instance, contains sample data from KBase’s reference data collection that can be used to try out the apps.
The Import tab allows you to upload your own data. KBase currently supports upload of a variety of data types. You can upload data up to 2GB using drag & drop or Globus for larger files. Please see the Data Upload/Download Guide for more information.
Note: Any data you upload to KBase is private unless you choose to share it.
When you hover over a data object in the Data Browser, a blue “< Add” button will appear to its left. Click the button to add the data to your Narrative.
Notice that the data object now appears in the Data Panel. Once you finish adding data, exit the Data Browser by clicking either the “Close” button at the bottom left of the browser window or the arrow at the top right of the Data Panel.
Don’t forget to periodically save your Narrative by clicking the “Save” button at the top right of the interface.
Once you have added data to your Narrative, you can analyze it using one or more of the KBase apps listed in the App Panel below your data.
There are options for filtering by category, name, input type, and more. You can designate apps you like as favorites using the star icon.
To add an app to your Narrative from the App Panel, click on its name or icon. You can get more information about an app by hovering over it until “…” appears and clicking on it.
Fill in all the required fields in your App. Note that some app fields are “smart” and can recognize which data in your Narrative are valid input for those fields. These smart fields have a pulldown list of all the data objects from your Data Panel that you can choose from as input.
When all required fields have been filled out, click the green “Run” button near the top left of the app cell to start the analysis.
Choosing the same output name for data objects will overwrite existing data objects of the same type with that name.
While the analysis is running, you will see the progress in the Job Status tab of the app box. When it finishes, the results will show up in the Result tab.
Please see the KBase Apps section of the Narrative Interface User Guide for more details on running apps.
All Narratives that you create are private by default. You can make a Narrative public or share it with specific collaborators by clicking the “share” button near the top right of your Narrative.
With these basic steps, you now can begin using the Narrative Interface to create Narratives and analyze data. For a more in-depth introduction to any of the topics mentioned here, see the Narrative User Guide.
