LogoLogo
Illumina KnowledgeIllumina SupportSign In
  • Home
  • Start Here
  • Overview
    • Software Overview
    • What's New
    • FAQ
    • Technical Assistance
    • Release Notes
    • Data Model
    • Account Types
    • Professional Services
  • Automate
    • Data Automation Overview
    • Automatic Data Flow
    • Automatic Data Aggregation
      • Unlock Biosamples
      • Correct Aggregation
    • Request A Lab Requeue
    • Yield
    • Yield Examples
      • Example 1
      • Example 2
      • Example 3
    • Automate Lane QC
    • Manual QC
    • Statuses
  • Manage Data
    • Import Demo Data
    • Delete Data
    • Import Data Into Projects
      • FastQ Upload Requirements
    • Download Data
      • Download Individual Files
      • Download Datasets
      • Download Run Files
      • Download Project Files
      • Download Analysis Files
      • Download Samples
    • Copy Datasets
    • Transfer Ownership
    • Archival Storage
    • Automatic Data Deletion
  • Sequence
    • Sample Sheets
      • Mapping Sequencing Runs to Biosamples
    • Fix Indexes
    • Plan Runs
      • Plan a NextSeq 1000/2000 Run
        • Set up NextSeq 1000/2000 Secondary Analysis
        • Custom Noise Baseline File
      • Plan a NovaSeq X Series Run
        • Set up NovaSeq X Series Secondary Analysis
        • NovaSeq X Series Custom Reference File
      • Create a Custom Index Adapter Kit
      • Import samples
      • Requeue a Planned Run
      • Analysis Configuration Template
      • Prep Tab
        • Create Biological Samples
        • Import Biological Samples
        • Prep Libraries
        • Import Sample Libraries
        • Set Up a Custom Library Prep Kit
        • Pool Libraries
        • Plan Run Using Prep Tab
        • Neo Prep
          • Configure
          • Assign Wells
          • Review
  • Microarray
    • Getting Started
      • Troubleshooting iScan Integration
    • Analysis Setup
    • Data Management
  • Analyze
    • Analyze Data
    • Launching Apps
    • Analysis Workflows
    • Re-Launch Analysis
    • Auto Analysis QC
    • Basespace Apps
  • Collaborate
    • Sharing Data
    • Access Shared Data
    • Share with Collaborators
      • Share Analyses
      • Track Analysis Delivery Status
      • Share By Link
      • Share By Email
      • Manage Collaborator Access
      • Data Access After Share / Transfer
    • Workgroups
    • Manage Workgroups
      • Access Workgroups
      • Create a Workgroup and Assign Admins
      • Rename a Workgroup
      • Add Users to a Workgroup
      • Remove Users from a Workgroup
      • Add Admins to a Workgroup
      • Remove Admins from a Workgroup
      • Manage User Access
  • Manage Your Account
    • Change Password
    • iCredits and Billing
    • Generate Usage Reports
    • Manage Enterprise Domains
    • Global Regions
  • Developer Tools
    • Basespace API
    • Developer Tools
  • Files Used By Basespace
    • Biosample Workflow Files
    • BAM Files
    • FastQ Files
    • Quality Scores
    • VCF Files
    • gVCF Files
  • Data
    • View Data
      • View Runs
        • View Run Summary
        • View Run Biosamples
        • View Run Samples
        • View Run Charts
        • View Run Metrics
        • View Run Indexing QC
        • View Run Samplesheet
        • View Run Files
      • View Projects
      • View Analyses
      • View Biosamples
  • Projects
    • Create a Project
    • Edit Project Details
  • Runs
    • Fix Sample Sheet
    • Automated Run Zipping
  • Biosamples
    • Biosample Overview
    • Manage Biosamples
    • Biosample Workflow
      • Add Biosamples
      • Add Prep Requests
      • Add Analysis Workflows to an Existing Biosample
      • Schedule Multiple Analysis Workflows for a Biosample
      • Schedule Analysis Workflow - Multiple Biosamples
    • Associating Biosamples with Projects
  • Samples
    • Combine Samples
    • Copy Samples
  • Cmd Line Interfaces
    • Basespace CLI
      • Introduction to Basemount
  • Additional Resources
    • Additional Resources
      • Informatics Blog
      • Coverage Calculator
      • Support Bulletins
      • Training
      • Security Model
      • Data Streaming
      • AWS
  • Releases
    • Previous Releases
      • 2025
        • 7.33.0 - Shared BCL Convert Section
        • 7.32.0 - File Preview in Search
        • 7.31.0 - Usage Explorer
        • 7.30.0 - Prep Tab Deprecation
      • 2024
        • 7.29.0 - Improved Analysis Error Reporting
        • 7.28.0 - MiSeq i100 Support
        • 7.27.0 - App Store Upgrade
        • 7.26.0 - Prep Tab Obsolescence Notification
        • 7.25.0 - Project Column in the Analysis Files Tab
        • 7.24.0 - Requeue Improvements
        • 7.23.0 - BaseSpace CLI v1.6.0
        • 7.22.0 - Analysis Autolaunch for NovaSeq X Manual Mode Runs
        • 7.21.0 - Improved Look and Feel
        • 7.20.0 - Analysis List Improvements
        • 7.19.0 - Transfer of NovaSeq X Projects
        • 7.18.0 - Custom Kit Deletion
      • 2023
        • 7.17.0 - Deletion of Biosample Default Projects
        • 7.16.0 - Transfer of NovaSeq X Runs
        • 7.15.0 - Compatibility Filtering in Run Planning
        • 7.14.0 - Native App Engine Update
        • 7.13.0 - Sharing for NovaSeq X Runs and Analyses
        • 7.12.0 - Combined New and Classic Modes
        • 7.11.0 - NovaSeq X Analysis Requeue
        • 7.10.0 - NovaSeq X Analysis Autolaunch Improvements
        • 7.9.0 - Multi-Analysis Run Planning
        • 7.8.0 - Performance Improvements
      • 2022
        • 7.7.0 - NovaSeqX Support
        • 7.6.0 - Custom Configuration Files in Microarray Analysis Setup
        • 7.5.0 - Performance Enhancements
        • 7.4.0 - Run Planning Enhancements
        • 7.3.0 - Improve App Launch Performance
        • 7.2.0 - FastQ Generation and other Bug Fixes
        • 7.1.0 - FastQ Related Fixes and Performance Improvements
        • 7.0.0 - Datasets and Apps Performance
        • 6.19.0 - ICA Integration Enhancements
        • 6.18.0 - ICA Integration with BCL Convert
        • 6.17.0 - Preliminary ICA Integration
      • 2021
        • 6.16.0
        • 6.15.0
        • 6.14.0
        • 6.13.0
        • 6.12.0
        • 6.11.0
        • 6.10.0
        • 6.9.0
        • 6.8.0
        • 6.7.0
        • 6.6.0
        • 6.5.0
      • 2020
        • 6.4.0
        • 6.3.0
        • 6.2.0
        • 6.1.0
        • 6.0.0
        • 5.46.0
        • 5.45.0
        • 5.44.0
        • 5.43.0
        • 5.42.0
      • 2019
        • 5.41.0
        • 5.40.0
        • 5.39.0
        • 5.38.0
        • 5.37.0
        • 5.36.0
        • 5.35.0
        • 5.34.0
        • 5.33.0
        • 5.32.0
        • 5.31.0
        • 5.30.0
      • 2018
        • 5.29.0
        • 5.28.0
        • 5.27.0
        • 5.26.0
        • 5.25.0
        • 5.24.0
        • 5.23.0
        • 5.22.0
        • 5.21.1
        • 5.21.0
        • 5.20.0
        • 5.19.0
        • 5.18.0
        • 5.17.0
        • 5.16.0
        • 5.15.0
        • 5.14.0
        • 5.13.0
        • 5.12.0
        • 5.11.0
      • 2017
        • 5.10.0
        • 5.9.0
        • 5.8.0
        • 5.7.0
        • 5.6.0
        • 5.5.0
        • 5.4.0
        • 5.3.0
        • 5.2.0
        • 5.1.0
        • 5.0.0
        • 4.27.0
        • 4.26.0
        • 4.25.0
        • 4.24.0
        • 4.23.0
        • 4.22.0
        • 4.21.0
        • 4.20.0
        • 4.19.0
        • 4.18.0
        • 4.17.0
        • 4.16.0
        • 4.15.0
      • 2016
        • 4.14.0
        • 4.13.0
        • 4.12.0
        • 4.11.0
        • 4.10.0
        • 4.9.0
        • 4.8.0
        • 4.7.0
        • 4.6.0
        • 4.5.0
        • 4.4.0
        • 4.3.0
        • 4.2.0
        • 4.1.0
        • 4.0.4
        • 4.0.3
        • 4.0.2
        • 4.0.1
        • 4.0.0
      • 2015
        • 3.23.2
        • 3.23.1
        • 3.23.0 Issues
        • 3.23.0
        • 3.20.4
        • 3.20.3
        • 3.20.0
        • 3.19.1
        • 3.19.0
        • 3.18.0
        • 3.17.1
        • 3.17.0
        • 3.16.2
        • 3.16.0
        • 3.15.2
        • 3.15.1
    • Release notifications
Powered by GitBook
On this page
  • Biosamples
  • What are biosamples?
  • How do I add biosamples?
  • What happened to my samples?
  • How do I add libraries and pools?
  • What are library prep kits?
  • What is biosample metadata?
  • Do biosamples belong in a project?
  • What happens when I import FASTQ files from my desktop now that samples were replaced with biosamples?
  • Can I delete biosamples?
  • What happens when I cancel biosamples?
  • Runs
  • Automated Run Zipping
  • What is yield and how is it calculated?
  • How do I update my lane QC thresholds?
  • What happens when a Generate FASTQ appsession aborts?
  • Analyses
  • What are Analysis Workflows?
  • How do I use biosamples to launch new analyses?
  • How is data gathered before auto-launching apps?
  • How do I reschedule an analysis workflow to run again?
  • What is an analysis' delivery status and how do I use it?
  • Lab Requeues
  • What are lab requeues and how do I use them?
  • Datasets
  • What are datasets?
  • Where do I find my datasets?

Was this helpful?

Export as PDF
  1. Overview

FAQ

PreviousWhat's NewNextTechnical Assistance

Last updated 1 year ago

Was this helpful?

Biosamples

What are biosamples?

Biosamples are the original DNA samples that needs to be prepared, sequenced, and analyzed to produce the desired results for a bioinformatician. In BaseSpace Sequence Hub, they are the central link for related physical entities and digital data such as libraries, pools, runs, lanes, analyses, and data sets.

How do I add biosamples?

Add biosamples in a biosample workflow file. You can download a template and upload completed files from the Biosamples page, available from the My Data tab. In the biosample workflow *.csv file, add information about the new biosamples, the projects you want to store data in, the library preps you want to use, the yields required to launch an app, and the analysis workflows you want to schedule. BaseSpace Sequence Hub validates the inputs and adds the biosamples to the system. For more information, see .

What happened to my samples?

Samples can still be accessed through a Run or a Project, using the Samples tab.

How do I add libraries and pools?

Libraries and pools are not uploaded manually but are generated automatically using the information in a sample sheet with an instrument run upload. From the sample sheet, Sample ID is used for the biosample name, and Sample Name is used for the library name.

When a biosample name is recognized due to a previous biosample workflow upload or instrument run containing the biosample, BaseSpace Sequence Hub checks the sample sheet for a match to a library. If we find an exact match, we add sequencing data to the existing biosample and library. If we don't find exact matches, we create a new biosample, a new library, or both.

When more than one library is given for a single lane number in the sample sheet, we interpret this as a pooled sample merged together using the libraries. We automatically assign a name to the pool and link it to the biosample and libraries. If the same combination of libraries exists within the same instrument run, the generated data are linked to the same pool. Library combinations cannot be reliably matched to runs across different instruments; in those cases, new pools are created.

The libraries and pools automatically generated from a sample sheet can be found in the Libraries tab of the biosample details page.

What are library prep kits?

Library prep kits are the names of the sample preparation kits used to turn biosamples into sample libraries. They are defined in the Prep Request column in the biosample workflow upload. BaseSpace Sequence Hub uses this information to separate data during data aggregation when there are two or more library prep kits used for the same biosample. For example, if you use a TruSeq PCR-Free library prep kit to prepare your libraries but receive poor results due to a low starting concentration of DNA, then make a second attempt with a TruSeq Nano library prep kit to amplify the DNA, you can use Sequence Hub to separate the data produced by the kit used to prepare the data.

Yield for a biosample is separated per unique library prep kit. View the list of prep kits for a biosample on the Summary tab of the biosample details page.

To launch an app using only the data from specific kits, select Select Biosample button when selecting the app inputs. This options enables a biosample chooser where you can select data by library prep kit.

What is biosample metadata?

Biosample metadata are key-value pairs used to save custom information to biosamples. The metadata can be viewed from the biosample summary page. Biosample metadata can only be entered when first creating the biosamples through the biosample workflow spreadsheet upload. When you add custom columns to the spreadsheet and define the values for the biosamples, the biosamples are imported with the metadata.

Do biosamples belong in a project?

Biosamples do not belong in a project. Instead, biosamples are related to a project by producing sequencing data in the form of data sets, which do belong in projects. Biosamples can have a default project, which is the default location data is written to when it is produced through Generate FASTQ and other BaseSpace Sequence Hub apps.

Biosamples can be related to many projects by creating data sets in each of them. For example, a biosample may be assigned a default project named Project A, where its FASTQ data sets are saved to. You can select the biosample as an input to manually launch an app and specify a different project, Project B, as the output project. The app then creates general data sets in Project B. The biosample is now linked to both projects, but does not belong to either of them.

What happens when I import FASTQ files from my desktop now that samples were replaced with biosamples?

When you upload FASTQ files, you create a new FASTQ data set which must be linked to a new biosample and library. Our new data model uses automatic aggregation of data to exclude any failures or low quality data among the biosamples, libraries, pools, lanes, and data sets. To allow auto-app launch to work, manual uploading of FASTQ files must conform to this model. The modified file import page will allow the creation of new biosamples and libraries to support adding FASTQ files to Sequence Hub.

Can I delete biosamples?

Biosamples themselves cannot be deleted. However, the data within biosamples can be deleted, either by deleting associated analyses or by deleting individual datasets using the FASTQ Datasets or Other Datasets tabs.

What happens when I cancel biosamples?

Canceling a biosample affects further work initiated to be performed on biosample data. Analyses that have not already been completed or stopped are canceled and their delivery status is changed to Do Not Deliver. These biosamples no longer appear in the available list of biosamples to be selected for app launch. Lab requeues can no longer be created for these biosamples and new biosamples cannot be created with the same name.

Runs

Automated Run Zipping

What is yield and how is it calculated?

Yield is a measure of how much sequencing data has been produced, in units of base pairs. Yield is the most commonly used app dependency to automatically launch an analysis for a biosample. BaseSpace Sequence Hub determines how much yield was produced from each flow cell lane the biosample was sequenced on, even if the biosample was merged into a pool with other biosamples.

How do I update my lane QC thresholds?

What happens when a Generate FASTQ appsession aborts?

The Generate FASTQ app runs immediately after a run completes to convert .bcl files to .fastq files and demultiplex any indexing that occurred. If the app fails to finish, the status changes to Aborted, which causes the sequencing run status to change to Failed.

You can use the Fix Sample Sheet and Requeue option in the Run Details page to restart the Generate FASTQ analysis. This initiates a new Generate FASTQ analysis and resets the sequencing run status to Analyzing.

Analyses

What are Analysis Workflows?

Analysis workflows are templates that contain pre-defined settings and QC thresholds for a specific app. These workflows can be scheduled in advance to automatically launch when minimum requirements, called dependencies, are met.

How do I use biosamples to launch new analyses?

You can schedule apps to automatically launch or you can manually launch them.

To automatically launch an app, schedule an analysis workflow in a biosample workflow file. When enough yield or other dependencies are met for the analysis workflow, the analysis uses the biosample as an input to launch automatically.

Manually launch apps through the app details page. Apps that formerly required samples now require biosamples. Select inputs from a list of biosamples that contain FASTQ data sets.

How is data gathered before auto-launching apps?

The new data model supports data aggregation for the same biosample placed in multiple flow cell lanes in multiple runs. BaseSpace Sequence Hub now automatically locates and merges different samples for you before launching an app. When a biosample is linked with multiple libraries of a similar type, placed on different lanes, and placed on different flowcell runs, we can collect all of the FASTQ files produced exclusively for the original sample and input them into the app.

BaseSpace Sequence Hub excludes data that do not meet quality thresholds, which improves the chances of success in running apps. Immediately before an app is launched with biosamples as the input, BaseSpace Sequence Hub checks the statuses of all resources that produced the FASTQ data sets, including libraries, pools, data sets, runs, and lanes. For example, if a sequencing lane had failed due to quality, the app will not include any FASTQ data sets produced from that specific lane.

You can manually override QC statuses. For example, you can set a pool to Failed, which automatically excludes all FASTQ data sets produced by the pool.

How do I reschedule an analysis workflow to run again?

The biosample workflow upload allows you to specify an existing biosample in the analysis workflow column of the spreadsheet. As long as the biosample name given is an exact match with a biosample already owned by the uploading user, the analysis workflow is added to the existing biosample.

What is an analysis' delivery status and how do I use it?

Lab Requeues

What are lab requeues and how do I use them?

Lab requeues are a way to request more yield when a biosample falls short of what is required to run an app successfully. When a biosample has not produced the required yield in the specified time, it is marked as Missing Yield. You can initiate a lab requeue to request the sequencing lab to produce more data to make up for the missing amount.

When you initiate a lab requeue, you specify the checkpoint in the sample prep steps the lab should begin from. You can initiate more than one requeue at the same time, but Illumina recommends that only one lab requeue be fulfilled at a time.

Datasets

What are datasets?

Datasets are bundles of one or more files output by BaseSpace Sequence Hub apps. They can be used as input to other BaseSpace Sequence Hub apps when chaining apps together. Datasets belong in projects and are included if the project they are in is shared or transferred.

Where do I find my datasets?

Datasets can be viewed two ways,

  • In a Project view, using the FASTQs or Other Datasets tabs

  • In a Biosamples view, using the FASTQs or Other Datasets tabs

When a project is shared or transferred, some biosample data to the project is shared with the collaborator. For more information, see .

Please see a thorough list of FAQs .

Yield amounts include only high quality yield and exclude failed data or data produced by an entity that was marked as failed. For more information, see .

BaseSpace Sequence Hub automatically tracks yield and updates status if yield is missing so you can request more sequencing data. For more information, see .

Lane QC thresholds are a user setting that applies to the metrics of lanes from all runs the user owns, once the run is complete. You can set the thresholds using the API. For more information, see the developer documentation at .

Use the biosample workflow upload to schedule analyses for either new or existing biosamples. The analyses remain in Pending status until they can be launched. For more information, see .

For more information, see and .

The delivery status of an analysis is a manually updated, independent status used for tracking the progress of sending data to another user. You can use this to mark the data to be delivered and track the status of review and delivery . For more information, see .

When yield shows up in the form of another sequencing run, the lab status transitions to Sequencing. If enough shows up to meet the requested amount, the lab requeue status updated to Fulfilled. For more information, see .

Sharing Data
Yield
Request a Lab Requeue
developer.basespace.illumina.com
Analysis Workflows
Automatic Data Aggregation
Manual QC
Share Analyses
Request a Lab Requeue
Add Biosamples
here