arrow-left

All pages
gitbookPowered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Command-Line Options

Option
Required
Description

--help

No

Displays a help screen with available command line options.

--analysisFolder

No

Path to the local analysis folder. The default location is /staging/DRAGEN_TSO500_CTDNA_2.6.0_Analysis_{timestamp}. If not using the default location, provide the full path to the local analysis folder. Folder must have sufficient space and must be on an NVMe SSD drive. For example, the /staging directory on the DRAGEN server. Refer to table in for minimum disk space requirements.

--resourcesFolder

No

Path to the resource folder location. The default location is /staging/illumina/DRAGEN_TSO500_CTDNA_2.6.0/resources. If not using the default location, enter the full path to the resource folder.

Note:

  • Use full paths when specifying the file paths in the command line.

  • Avoid special characters such as &, *, #, and spaces.

  • When starting from BCL files, only the run folder needs to be specified. The immediate parent directory containing the BCL files does not need to be specified.

When running the analysis software using SSH, Illumina recommends using additional software to prevent unexpected termination of analysis. Illumina recommends screen and tmux.

  1. Wait for any running DRAGEN TruSight Oncology 500 ctDNA Analysis Software containers to complete before launching a new analysis. Run the following command to generate a list of running containers:docker ps

  2. Select from one of the following options:

  • Start from BCL files in the run folder with the sample sheet included in the run folder. DRAGEN_TSO500_CTDNA-2.6.0.sh \ --runFolder /staging/{RunFolderName} \ --analysisFolder /staging/{AnalysisFolderName}

  • Start from BCL files in the run folder with the sample sheet located in a folder other than the run folder. DRAGEN_TSO500_CTDNA.sh \ --runFolder /staging/{RunFolderName} \ --analysisFolder /staging/{AnalysisFolderName} \

hashtag
Starting from BCL Files

If starting from BCL (*.bcl) files, DRAGEN TruSight Oncology 500 ctDNA Analysis Software requires the run folder to contain certain files and folders. These inputs are required for Docker.

The run folder contains data from the sequencing run, make sure that the folder contains the following files:

Folder/File
Description

hashtag
Starting from FASTQ Files

The following inputs are required for running the DRAGEN TruSight Oncology 500 ctDNA Analysis Software using FASTQ (*.fastq) files. The requirements apply to Docker.

  • Full path to an existing FASTQ folder.

  • The FASTQ folder structure conforms to the folder structure in

  • The sample sheet is in the FASTQ folder path, or you can set the path to the sample sheet with the --sampleSheet override command line option.

Make sure there is sufficient disk space for the analysis to complete. Refer to the --help command line argument details for disk space requirements.

circle-info

Use BCL Convert to produce FASTQ files for DRAGEN TruSight Oncology 500 ctDNA Analysis Software. Using bcl2fastq does not produce the same results and is discouraged.

circle-info

Make sure that BCL Convert is set to write UMI sequences to the read headers in the FASTQ files.

hashtag
FASTQ File Organization

Store FASTQ files in individual subfolders that correspond to a specific Sample_ID. Keep file pairs together in the same folder. Alternatively, store the FASTQ files in one flat folder structure where the FASTQ files are stored in one folder.

The DRAGEN TruSight Oncology 500 ctDNA Analysis Software requires separate FASTQ files per sample. Do not merge FASTQ files.

The instrument generates two FASTQ files per flow cell lane, so that there are eight FASTQ files per sample.

Sample1_S1_L001_R1_001.fastq.gz

  • Sample1 represents the Sample ID.

  • The S in S1 means sample, and the 1 in S1 is based on the order of samples in the sample sheet, so S1 is the first sample.

  • L001 represents the flow cell lane number.

--sampleSheet /staging/{SampleSheetName}.csv
  • Start from BCL files in the run folder with a different sample sheet and demultiplexing only. DRAGEN_TSO500_CTDNA-2.6.0.sh \ --runFolder /staging/{RunFolderName} \ --analysisFolder /staging/{AnalysisFolderName} \ --sampleSheet /staging/{SampleSheetName}.csv \ --demultiplexOnly

  • Start from FASTQ folder with sample sheet included in the FASTQ folder and subset of samples. DRAGEN_TSO500_CTDNA-2.6.0.sh \ --fastqFolder /staging/{FastqFolderName} \ --analysisFolder /staging/{AnalysisFolderName} \ --sampleOrPairIDs "Sample_1,Sample_2"

  • RunInfo.xml file

    Run information.

    RunParameters.xml file

    Run parameters.

    SampleSheet.csv file

    Sample information. If you want to use a sample sheet that is not in the run folder or a sample sheet named something other than SampleSheet.csv, provide the full path.

    The R in R1 means Read, so R1 refers to Read 1.

    --runFolder

    Yes

    Required when --fastqFolder is not specified. Provide the full path to the local run folder.

    --fastqFolder

    Yes

    Required when --runFolder is not specified. Provide the full path to the local FASTQ folder. Analysis starts at this location.

    --user

    No

    Optional for Docker. Specify the user ID to be used within the Docker container.

    --version

    No

    Displays the version of the software.

    --sampleSheet

    No

    Provide the full path, including file name, if not provided as SampleSheet.csv in the run folder

    --sampleOrPairIDs

    No

    Provide the comma-delimited sample IDs that should be processed on this node with no spaces. For example, Sample_1,Sample_2.

    --demultiplexOnly

    No

    Demultiplex to generate FASTQ only without additional analysis.

    Config folder

    Configuration files

    Data folder

    *.bcl files

    Images folder

    [Optional] Raw sequencing image files.

    Interop folder

    Interop metric files.

    Logs folder

    [Optional] Sequencing system log files.

    RTALogs folder

    Real-Time Analysis (RTA) log files.

    FASTQ File Organization.
    Storage Requirements

    Launching Analysis

    Analysis Launch on ICA

    hashtag
    Methods for Launching Analysis

    Illumina Connected Analytics (ICA) supports the following methods for launching DRAGEN TruSight Oncology 500 ctDNA Analysis Software.

    • Auto-launch—Stream run data directly from the instrument to ICA via a specially configured sample sheet and automatically begin DRAGEN TSO 500 ctDNA analysis.

    • —Initiate DRAGEN TSO 500 ctDNA analysis on ICA using the run files and sample sheet files in the project.

    For more information about using ICA or BaseSpace Sequence Hub, refer to the following support pages on the Illumina support site.

    Manual launch
    Illumina Connected Analytics support site pagearrow-up-right
    BaseSpace Sequence Hub support site pagearrow-up-right

    Analysis Launch on Standalone DRAGEN Server

    Start the DRAGEN TruSight Oncology 500 ctDNA Analysis Software with the DRAGEN_TSO500_CTDNA-2.6.0.sh Bash script. The script is installed in the /usr/local/bin directory. The Bash script is executed on the command line and runs the software with Docker (or Apptainer if specified).

    For arguments, refer to Command-Line Options. You can start from BCL files or from the FASTQ folder produced by BCL Convert. The following requirements apply for both methods:

    • Path to the sequencing run or FASTQ folder. Copy the run or FASTQ folder to the DRAGEN server into the staging folder with the following recommended organization: /staging/runs/{RunID}. You can copy the run folder onto the DRAGEN server using Linux commands such as rsync. The sample sheet within the run folder is used unless otherwise specified through the command line.

    • Run folder must be intact. Refer to for input requirements.

    • If the analysis output folder path is different from the default, provide the analysis output folder path. Refer to .

    circle-info

    Before running the analysis, confirm that the output directory for the software to write to is empty and does not include results of previous analyses.

    hashtag
    Storage Requirements

    For optimal performance, run analysis on data stored locally on the DRAGEN server. Analysis of data stored on NAS can take longer and performance can be less reliable.

    The DRAGEN server provides an NVMe SSD in the /staging directory to use as the software output directory. Network-attached storage is required for long-term storage.

    When running the DRAGEN TruSight Oncology 500 ctDNA Analysis Software, use the default settings or set the -analysisFolder command line option to a directory in /staging to make sure the DRAGEN server processes read and write data on the NVMe SSD.

    Before beginning analysis, develop a strategy to copy data from the DRAGEN server to a network‑attached storage. Delete output data on the DRAGEN server as soon as possible.

    The following are the run and analysis output sizes for each sequencing system per 101 bp:

    Sequencing System
    Run Folder Output (Gb)
    Analysis Output (Gb)
    Minimum Disk Space (Gb)

    When launching the analysis, the software checks that the minimum disk space required is available. If the minimum disk space is not available, the software shows an error message and prevents analysis from starting. If disk space is exhausted during a run, the run shows an error and stops analyzing.

    circle-exclamation

    Moving or modifying files during an analysis may cause the analysis to fail or provide incorrect results.

    Auto-Launch with FASTQs generated by Standalone BCL Convert Pipeline (Start from FASTQ)

    When using BSSH Run Planning to generate a sample sheet to auto-Launch analysis on ICA, you must designate "Start from Fastq" to be True or False (default is False). If you choose "False", BSSH will kick off the TSO 500 pipeline normally using BCL input from the run folder.

    If you choose "True" for this option, BSSH will run two ICA pipelines in sequence:

    • First, it will run the BCL Convert v3.10.9 pipeline to generate the FASTQ files

    • Second, it will kick off the TSO 500 ctDNA pipeline using the FASTQ files generated above as the input

    circle-exclamation

    Please note. Run QC metrics are generated inside the TSO 500 pipeline from interop files in the run folder. When starting TSO 500 ctDNA from FASTQ (via auto-launch or manual launch), Run QC metrics will not be generated.

    When the auto-launched analysis completed, you will see the analysis result shows results from both the BCL Convert pipeline and the TSO 500 ctDNA pipeline, like below:

    Input Checks

    Items to check before submitting your analysis

    hashtag
    Input Validation Steps

    In addition to sample sheet validation, before starting an analysis, the software performs the following checks:

    • Resource bundle integrity

    DRAGEN license validity

  • NEW in v2.6.3! Instrument Type determination

  • Instrument type is required by the software because different instrument platforms produce output with distinct systematic noise profiles. DRAGEN TSO 500 ctDNA analysis software requires instrument-specific baseline noise files. Before kicking off analysis, the software determines the instrument type in order to select which baseline files to use. This means that even when starting from FASTQ, all samples in the run must be sequenced on the same type of instrument.

    hashtag
    Instrument Type Determination for Baselines

    When starting analysis from BCL files, the software references the RunInfo.xml file in the Run folder to identify the sequencing instrument type. For analyses beginning with FASTQ files, the software reads the FASTQ file headers for this information.

    Instrument Serial Number Prefix
    Instrument Type

    A

    NovaSeq6000

    ADX

    NovaSeq6000Dx

    VH

    NextSeq1k2k

    LH

    NovaSeqXPlus

    LL

    NovaSeqX

    triangle-exclamation

    For analysis starting from FASTQ files, if a mixed instrument type is detected, the software will exit with an error.

    The Combined Variant Output File will include the instrument type Combined Variant Output

    Systematic Noise files for certain variant types depend on library prep kit, instrument type, or both. The software will select the correct set of resource files (systematic noise, panel of normals) according to its determination of instrument type and library prep kit. VCF headers contain details on which resource files were used in the analysis.

    • Library Preparation Kit: TSO500 ctDNA v2 (index length: 10)

      • Instrument Types:

        • NovaSeq 6000, NovaSeq 6000Dx: Use one set of baselines.

        • NextSeq 1000/ 2000: Use a different set of baselines.

        • NovaSeqX, NovaSeqXPlus: Use another set of baselines.

    • Library Preparation Kit: TSO500 ctDNA (index length: 8)

      • A single set of baselines applies to all instrument types.

    circle-exclamation

    If instrument type is undetermined (ie not matching any of the below), the software will set instrument type to NA, and the baselines for NovaSeq 6000 and NovaSeq 6000Dx will be applied.

    circle-exclamation

    If the software cannot detect the Library Prep Kit due to a missing index in the sample sheet, it will default to TSO500 ctDNA v2.

    1500

    NovaSeq 6000/6000Dx (RUO) S4 Flow Cell

    800-1200

    2700-4100

    3000

    NovaSeq X 1.5B

    213

    352

    800

    NovaSeq X 10B

    1100

    1800

    3000

    NovaSeq X 25B

    3042

    5177

    6000

    NextSeq 2000

    P4 Flow Cell

    223

    334

    500

    NovaSeq 6000/6000Dx (RUO) SP Flow Cell

    85-100

    250-374

    300

    NovaSeq 6000/6000Dx (RUO) S1 Flow Cell

    164-200

    360-665

    800

    NovaSeq 6000/6000Dx (RUO) S2 Flow Cell

    290-460

    Starting from BCL Files
    Command-Line Options

    890-1600

    Auto-Launch of DRAGEN TSO 500 ctDNA Analysis on ICA

    hashtag
    Auto-launch Prerequisites and Workflow

    *The BaseSpace Sequence Hub setting for run monitoring and storage must be selected on the instrument to use DRAGEN TSO 500 ctDNA analysis auto-launch. For information on preparing your instrument for DRAGEN TSO 500 ctDNA Auto-launch, refer to the documentation for your instrument.

    1. Use BaseSpace Sequence Hub Run Planning tool or the sample sheet templates provided on the support page to create and export a sample sheet.

      1. If BaseSpace Run Planning tool is not available in your region, use the sample sheet template.

    2. Import the sample sheet to the instrument and start the sequencing run. Refer to for sample sheet guidance.

      1. Data is uploaded to BaseSpace Sequence Hub and then pushed to ICA. You can monitor the run in BaseSpace Sequence Hub.

      2. Analysis auto launches in ICA when sequencing and the upload completes. You can monitor the status of the analysis in BaseSpace Sequence Hub or ICA

    3. View the analysis output results in either BaseSpace Sequence Hub or ICA.

    circle-exclamation

    To avoid invalid sample sheet configurations, Illumina recommends using BaseSpace Run Planning tool to generate sample sheets. Using an invalid sample sheet can result in failed runs and analyses.

    hashtag
    BaseSpace Sequence Hub Requirements for ICA Auto-Launch

    BaseSpace Run Planning tool is a multi-step workflow that generates a manual launch or auto-launch capable sample sheet for export and requires the following additional settings:

    • Access to BaseSpace Sequence Hub.

    • ICA Run Storage is enabled under BaseSpace Sequence Hub settings.

    Refer to the for information on setting up a BaseSpace Sequence Hub project.

    hashtag
    Requeue Analysis

    You can requeue analysis of a run via the run's Summary page in BaseSpace Sequence Hub.

    Refer to the for more information on requeuing an analysis.

    hashtag
    Minimum Storage Requirements on ICA

    Sequencing System
    Minimum Disk Space (Gb)

    Refer to the for information on how to manage accounts and subscriptions.

    hashtag
    Guided Examples

    Please review these guided examples of using DRAGEN TSO 500 Analysis Software with auto-launch on ICA:

    If necessary, you can requeue the analysis via BaseSpace Sequence Hub.

    NovaSeq X 25B

    6000

    NextSeq 2000 P4 Flow Cell

    500

    NovaSeq 6000/6000Dx (RUO) SP Flow Cell

    500

    NovaSeq 6000/6000Dx (RUO) S1 Flow Cell

    1100

    NovaSeq 6000/6000Dx (RUO) S2 Flow Cell

    2500

    NovaSeq 6000/6000Dx (RUO) S4 Flow Cell

    4300

    NovaSeq X 1.5B

    2000

    NovaSeq X 10B

    4300

    ICA Auto-launch Sample Sheet Requirements
    arrow-up-right
    BaseSpace Sequence Hub support site pagearrow-up-right
    BaseSpace Sequence Hub support site pagearrow-up-right
    Software Registration pagearrow-up-right
    NovaSeq 6000Dx: TSO 500 Auto-launch Analysis in Cloudarrow-up-right

    Manual Launch of DRAGEN TSO 500 ctDNA Analysis on ICA

    hashtag
    How to Launch Analysis

    1. Create a Project: Project can be specific for the DRAGEN TruSight Oncology 500 ctDNA pipeline or it can contain multiple Pipelines and/or Tools). For information on creating Projects, refer to the Projects section in Illumina Connected Analytics helparrow-up-right.

    circle-info

    ICA standard storage is used by default as soon as the Project is saved. To connect a different storage source, set it up before creating your Project. For details and options, refer to the Storage section in .

    1. Edit Project and Add Bundle: Edit the Project and add the bundle titled, "DRAGEN TSO 500 ctDNA v2.6.0 (XX)." XX is a 2-letter code designating the region from which you are launching the analysis. Adding the Bundle automatically adds the pipeline and associated resource files and datasets to the Project. For information on Bundles, refer to the Bundles section in .

    circle-info

    After adding the Bundle to the Project, an example dataset becomes available in the Demo_Data folder for the Project. 

    1.  Upload the sequencing data: For information on viewing and uploading data, refer to the Data section in .

    2. Start Analysis: In the Project, navigate to Pipelines, select the TSO 500 ctDNA v2.6.0 Pipeline, and then select  "Start New Analysis". Set up the new analysis by configuring the parameters listed in the . When the required files are completed, start analysis.

    3. Download Results: After analysis is complete, navigate to results in the configured output location.

    Please see the Illumina Support Shorts for guidance on how to set up and run DRAGEN TSO 500 RUO analysis on ICA. This is the same process as DRAGEN TSO 500 ctDNA, but with different inputs specific to DRAGEN TSO 500 solid:

    hashtag
    Analysis Parameters on ICA

    To launch an analysis via the ICA user interface, configure a DRAGEN TSO 500 ctDNA pipeline analysis with the following parameters.

    Parameter Name
    Description

    hashtag
    Known Limitations

    • FASTQ Folder Naming Requirements

      • When specifying input FASTQ folder names, avoid using folder names that consist entirely of numeric characters with a leading zero, as this will cause the software to error out.

      • Unsupported naming pattern:

    For information about using pipelines, refer to .

    Input Folder

    The run folder or FASTQ folder that contains files to analyze.

    FASTQ List CSV

    Do not use, this only applies to auto-launch TSO 500 ctDNA analysis from FASTQs after BCL auto-launch.

    Starts from FASTQ

    True for analysis performed on files in the FASTQ folder. False for analysis performed on files in the run folder.

    Sample or Pair IDs

    Optional subset of Sample IDs or Pair IDs to analyze.

    Sample List

    Do not use, this only applies to auto-launch TSO 500 ctDNA analysis from FASTQs after BCL auto-launch.

    Storage Size

    The storage size to allocate for the analysis. The default and recommended value is Large.

    '01234' (numeric-only with leading zero)

  • Supported naming patterns:

    • '12340' (numeric without leading zero)

    • 'sample01' (alphanumeric)

    • 'A1234' (alphanumeric)

    • 'test_sample' (alphanumeric with underscore)

  • User Reference

    The analysis run name.

    User Tags

    Text labels to help index the analysis.

    Notify me when task is completed

    Option to receive an email notification when analysis is complete.

    Output Folder

    The path to the analysis output folder. The default path is the project output folder.

    Entitlement Bundle

    Automatically populated from the project details.

    Sample Sheet

    Select a sample sheet in CSV format for the analysis.

    To note: Sample Sheet selection is optional if starting from a run folder, and required when submitting a FASTQ folder.

    Illumina Connected Analytics helparrow-up-right
    Illumina Connected Analytics helparrow-up-right
    Illumina Connected Analytics helparrow-up-right
    table below
    Illumina Connected Analytics support site pagearrow-up-right