Quick Start

Quick Start Guide

Table 1. Release Information

Execution Environment	software version	Client program	location	Note
Local Dragen Server	4.4.4.53	run_Solid_WGS_TN_{version}.sh	/usr/local/bin	See Dragen Server
Platform Core	c18e9e69-0a74-4c43-a419-a62cb7c6abc0	icav2	Platform Core Pipelines	See Cloud App
Platform Core	urn:ilmn:ica:pipeline:c18e9e69-0a74-4c43-a419-a62cb7c6abc0#Solid_WGS_TN_v4_4_4_53	supported browser	Platform Core UI	See Launching Cloud Analysis

• {version} is used to represent the software version number in Table 1 above. Similarly, <pipeline_run_script> is used to indicate the client program name in this document.

Download, Install and Execute on a Local Server

The software may be downloaded and installed by following the installation guide. It may be executed using a local DRAGEN server or on a local computer which launches the analysis in the ICA cloud environment.

Run analysis on a local DRAGEN Server

The command line program may be used to launch an analysis by using the ${CLI_program} with the appropriate options.

start from one or more input folders when using FASTQ, BAM or CRAM files

Multiple folders may be specified as input folders in comma separated values when using FASTQ, BAM or CRAM files as input.

<pipeline_run_script> --inputType <fastq|bam|cram> \
--inputFolder /staging/input-folder-1,/staging/input-folder-2 \
--analysisFolder /staging/output-folder

Pressing Ctrl+C during a Solid_WGS_TN_DRAGEN step stops the currently running analysis and might cause an FPGA error. To recover from an FPGA error, shut down and restart the server.

Run analysis on cloud using the icav2 client

Here is an example of starting an analysis using the icav2 client by providing the necessary command parameters and specify a particular storage size for analysis in cloud.

icav2 projectpipelines start nextflow ${PIPELINE_ID} \
--project-id ${ANY_PROJECT_ID} \
--storage-size Large \
-o json \
--input ${ANY_SAMPLE_SHEET} \
--input ${ANY_INPUT_DIR} \
--parameters inputType:'fastq' \
--parameters referenceGenome:'hg38' \
--parameters sampleIds:'Sample1,Sample2' \
--user-reference ${ANY_USER_REFERENCE}

Run analysis on cloud using UI

The same analysis example above may be completed using the Platform Core UI by logging into the appropriate domain of your company and project where the pipeline is set up.

Find more information in the Launching Analysis guide.