Back to Tool Docs Index

IdentifySoftClippedLoci

Generate a list of loci with three or more distinct bases detected

Category Public/Stable Tools

Overview

This walker will iterate a BAM and report sites where a high fraction of reads either begin or end soft clipping. The original purpose is to identify positions that likely represent structural variants. This tool can be run with or without a reference set of SVs.

Usage example:

  java -jar DISCVRseq.jar IdentifySoftClippedLoci \
     -R reference.fasta \
     -I bams.list \
     -O output.bed

Or you can provide a list of reference SVs. In this case, only sites that overlap the start/end of these SVs will be reported.

  java -jar DISCVRseq.jar IdentifySoftClippedLoci \
     -I bams.list \
     -rv reference.vcf.gz \
     -O output.bed

Would produce a BED file that looks like:

     chr20 10000000 10000001 BeforeSoftClip   +   Sample1 0.5 100 200
     chr20 10000865 10000866 AfterSoftClip    +   Sample1 0.25 50 200    2-DEL-pbsv.DEL.10391.clr|2|132589349|INDEL

Where the columns are: 1) Contig 2) Start (0-based) 3) End (0-based, exclusive) 4) Reason for inclusion, either BeforeSoftClip or AfterSoftClip 5) Strand (always listed as plus) 6) Sample Name 7) The percent of reads representing the start/end of the soft clip 8) Total reads representing the start/end of the soft clip 9) Total number of QC passing reads 10) If a reference VCF is provided, and variants that overlap with this site, within --maxVariantDistance, will be reported

Additional Information

Genome/Reference Files

Please note that if this tools uses a reference genome, that FASTA must be indexed with samtools and to have a sequence dictionary created with Picard. See here for more information

Read filters

These Read Filters are automatically applied to the data by the Engine before processing by IdentifySoftClippedLoci.

IdentifySoftClippedLoci specific arguments

This table summarizes the command-line arguments that are specific to this tool. For more details on each argument, see the list further down below the table or click on an argument name to jump directly to that entry in the list.

Argument name(s)	Default value	Summary
Required Arguments
--input -I	[]	BAM/SAM/CRAM file containing reads
Optional Tool Arguments
--arguments_file	[]	read one or more arguments files and add them to the command line
--cloud-index-prefetch-buffer -CIPB	-1	Size of the cloud-only prefetch buffer (in MB; 0 to disable). Defaults to cloudPrefetchBuffer if unset.
--cloud-prefetch-buffer -CPB	40	Size of the cloud-only prefetch buffer (in MB; 0 to disable).
--disable-bam-index-caching -DBIC	false	If true, don't cache bam indexes, this will reduce memory requirements but may harm performance if many intervals are specified. Caching is automatically disabled if there are no intervals specified.
--disable-sequence-dictionary-validation	false	If specified, do not check the sequence dictionaries from our inputs for compatibility. Use at your own risk!
--gcs-max-retries -gcs-retries	20	If the GCS bucket channel errors out, how many times it will attempt to re-initiate the connection
--gcs-project-for-requester-pays	""	Project to bill when accessing "requester pays" buckets. If unset, these buckets cannot be accessed. User must have storage.buckets.get permission on the bucket being accessed.
--help -h	false	display the help message
--interval-merging-rule -imr	ALL	Interval merging rule for abutting intervals
--intervals -L	[]	One or more genomic intervals over which to operate
--max-depth-per-sample	0	Maximum number of reads to retain per sample per locus. Reads above this threshold will be downsampled. Set to 0 to disable.
--maxVariantDistance -mvd	5	If a reference VCF is provided, a loci is considered as overlapping the variant if the site is +/- this many bp from the start or end of the variant
--minFraction	0.1	Any site where at least this fraction of reads represent either the beginning or the end of a soft clip will be considered
--output -O	null	The output BED file
--reference -R	null	Reference sequence
--refvcf -rv	null	Reference VCF
--sites-only-vcf-output	false	If true, don't emit genotype fields when writing vcf file output.
--version	false	display the version number for this tool
Optional Common Arguments
--add-output-sam-program-record	true	If true, adds a PG tag to created SAM/BAM/CRAM files.
--add-output-vcf-command-line	true	If true, adds a command line header line to created VCF files.
--create-output-bam-index -OBI	true	If true, create a BAM/CRAM index when writing a coordinate-sorted BAM/CRAM file.
--create-output-bam-md5 -OBM	false	If true, create a MD5 digest for any BAM/SAM/CRAM file created
--create-output-variant-index -OVI	true	If true, create a VCF index when writing a coordinate-sorted VCF file.
--create-output-variant-md5 -OVM	false	If true, create a a MD5 digest any VCF file created.
--disable-read-filter -DF	[]	Read filters to be disabled before analysis
--disable-tool-default-read-filters	false	Disable all tool default read filters (WARNING: many tools will not function correctly without their default read filters on)
--exclude-intervals -XL	[]	One or more genomic intervals to exclude from processing
--gatk-config-file	null	A configuration file to use with the GATK.
--interval-exclusion-padding -ixp	0	Amount of padding (in bp) to add to each interval you are excluding.
--interval-padding -ip	0	Amount of padding (in bp) to add to each interval you are including.
--interval-set-rule -isr	UNION	Set merging approach to use for combining interval inputs
--lenient -LE	false	Lenient processing of VCF files
--max-variants-per-shard	0	If non-zero, partitions VCF output into shards, each containing up to the given number of records.
--QUIET	false	Whether to suppress job-summary info on System.err.
--read-filter -RF	[]	Read filters to be applied before analysis
--read-index	[]	Indices to use for the read inputs. If specified, an index must be provided for every read input and in the same order as the read inputs. If this argument is not specified, the path to the index for each input will be inferred automatically.
--read-validation-stringency -VS	SILENT	Validation stringency for all SAM/BAM/CRAM/SRA files read by this program. The default stringency value SILENT can improve performance when processing a BAM file in which variable-length data (read, qualities, tags) do not otherwise need to be decoded.
--seconds-between-progress-updates	10.0	Output traversal statistics every time this many seconds elapse
--sequence-dictionary	null	Use the given sequence dictionary as the master/canonical sequence dictionary. Must be a .dict file.
--tmp-dir	null	Temp directory to use.
--use-jdk-deflater -jdk-deflater	false	Whether to use the JdkDeflater (as opposed to IntelDeflater)
--use-jdk-inflater -jdk-inflater	false	Whether to use the JdkInflater (as opposed to IntelInflater)
--verbosity	INFO	Control verbosity of logging.
Advanced Arguments
--minDepth	10	Minimum QC+ read depth before a locus is considered callable
--showHidden	false	display hidden arguments

Argument details

Arguments in this list are specific to this tool. Keep in mind that other arguments are available that are shared with other tools (e.g. command-line GATK arguments); see Inherited arguments above.

--add-output-sam-program-record / -add-output-sam-program-record

If true, adds a PG tag to created SAM/BAM/CRAM files.

boolean true

--add-output-vcf-command-line / -add-output-vcf-command-line

If true, adds a command line header line to created VCF files.

boolean true

--arguments_file / NA

read one or more arguments files and add them to the command line

List[File] []

--cloud-index-prefetch-buffer / -CIPB

Size of the cloud-only prefetch buffer (in MB; 0 to disable). Defaults to cloudPrefetchBuffer if unset.

int -1 [ [ -∞ ∞ ] ]

--cloud-prefetch-buffer / -CPB

Size of the cloud-only prefetch buffer (in MB; 0 to disable).

int 40 [ [ -∞ ∞ ] ]

--create-output-bam-index / -OBI

If true, create a BAM/CRAM index when writing a coordinate-sorted BAM/CRAM file.

boolean true

--create-output-bam-md5 / -OBM

If true, create a MD5 digest for any BAM/SAM/CRAM file created

boolean false

--create-output-variant-index / -OVI

If true, create a VCF index when writing a coordinate-sorted VCF file.

boolean true

--create-output-variant-md5 / -OVM

If true, create a a MD5 digest any VCF file created.

boolean false

--disable-bam-index-caching / -DBIC

If true, don't cache bam indexes, this will reduce memory requirements but may harm performance if many intervals are specified. Caching is automatically disabled if there are no intervals specified.

boolean false

--disable-read-filter / -DF

Read filters to be disabled before analysis

List[String] []

--disable-sequence-dictionary-validation / -disable-sequence-dictionary-validation

If specified, do not check the sequence dictionaries from our inputs for compatibility. Use at your own risk!

boolean false

--disable-tool-default-read-filters / -disable-tool-default-read-filters

Disable all tool default read filters (WARNING: many tools will not function correctly without their default read filters on)

boolean false

--exclude-intervals / -XL

One or more genomic intervals to exclude from processing
Use this argument to exclude certain parts of the genome from the analysis (like -L, but the opposite). This argument can be specified multiple times. You can use samtools-style intervals either explicitly on the command line (e.g. -XL 1 or -XL 1:100-200) or by loading in a file containing a list of intervals (e.g. -XL myFile.intervals). strings gathered from the command line -XL argument to be parsed into intervals to exclude

List[String] []

--gatk-config-file / NA

A configuration file to use with the GATK.

String null

--gcs-max-retries / -gcs-retries

If the GCS bucket channel errors out, how many times it will attempt to re-initiate the connection

int 20 [ [ -∞ ∞ ] ]

--gcs-project-for-requester-pays / NA

Project to bill when accessing "requester pays" buckets. If unset, these buckets cannot be accessed. User must have storage.buckets.get permission on the bucket being accessed.

String ""

--help / -h

display the help message

boolean false

--input / -I

BAM/SAM/CRAM file containing reads

R List[GATKPath] []

--interval-exclusion-padding / -ixp

Amount of padding (in bp) to add to each interval you are excluding.
Use this to add padding to the intervals specified using -XL. For example, '-XL 1:100' with a padding value of 20 would turn into '-XL 1:80-120'. This is typically used to add padding around targets when analyzing exomes.

int 0 [ [ -∞ ∞ ] ]

--interval-merging-rule / -imr

Interval merging rule for abutting intervals
By default, the program merges abutting intervals (i.e. intervals that are directly side-by-side but do not actually overlap) into a single continuous interval. However you can change this behavior if you want them to be treated as separate intervals instead.

The --interval-merging-rule argument is an enumerated type (IntervalMergingRule), which can have one of the following values:

ALL
OVERLAPPING_ONLY

IntervalMergingRule ALL

--interval-padding / -ip

Amount of padding (in bp) to add to each interval you are including.
Use this to add padding to the intervals specified using -L. For example, '-L 1:100' with a padding value of 20 would turn into '-L 1:80-120'. This is typically used to add padding around targets when analyzing exomes.

int 0 [ [ -∞ ∞ ] ]

--interval-set-rule / -isr

Set merging approach to use for combining interval inputs
By default, the program will take the UNION of all intervals specified using -L and/or -XL. However, you can change this setting for -L, for example if you want to take the INTERSECTION of the sets instead. E.g. to perform the analysis only on chromosome 1 exomes, you could specify -L exomes.intervals -L 1 --interval-set-rule INTERSECTION. However, it is not possible to modify the merging approach for intervals passed using -XL (they will always be merged using UNION). Note that if you specify both -L and -XL, the -XL interval set will be subtracted from the -L interval set.

The --interval-set-rule argument is an enumerated type (IntervalSetRule), which can have one of the following values:

UNION
INTERSECTION

IntervalSetRule UNION

--intervals / -L

One or more genomic intervals over which to operate

List[String] []

--lenient / -LE

Lenient processing of VCF files

boolean false

--max-depth-per-sample / -max-depth-per-sample

Maximum number of reads to retain per sample per locus. Reads above this threshold will be downsampled. Set to 0 to disable.

int 0 [ [ -∞ ∞ ] ]

--max-variants-per-shard / NA

If non-zero, partitions VCF output into shards, each containing up to the given number of records.

int 0 [ [ 0 ∞ ] ]

--maxVariantDistance / -mvd

If a reference VCF is provided, a loci is considered as overlapping the variant if the site is +/- this many bp from the start or end of the variant

int 5 [ [ -∞ ∞ ] ]

--minDepth / -minDepth

Minimum QC+ read depth before a locus is considered callable

int 10 [ [ -∞ ∞ ] ]

--minFraction / -minFraction

Any site where at least this fraction of reads represent either the beginning or the end of a soft clip will be considered

double 0.1 [ [ -∞ ∞ ] ]

--output / -O

The output BED file

File null

--QUIET / NA

Whether to suppress job-summary info on System.err.

Boolean false

--read-filter / -RF

Read filters to be applied before analysis

List[String] []

--read-index / -read-index

Indices to use for the read inputs. If specified, an index must be provided for every read input and in the same order as the read inputs. If this argument is not specified, the path to the index for each input will be inferred automatically.

List[GATKPath] []

--read-validation-stringency / -VS

Validation stringency for all SAM/BAM/CRAM/SRA files read by this program. The default stringency value SILENT can improve performance when processing a BAM file in which variable-length data (read, qualities, tags) do not otherwise need to be decoded.

The --read-validation-stringency argument is an enumerated type (ValidationStringency), which can have one of the following values: