Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Learning objectives:

  1. Identify structural variants in a new data set.

  2. Work with a new type of program that uses configuration files rather than entering all information on a single command at the command line. This is very similar to the queue system TACC uses making this a good introduction.

...

Code Block
cd $SCRATCH/GVA_sv_tutorial
conda activate GVA-SV
BAM_preprocessingPairs.pl -p 0 61FTVAAXX.sam &> preprocessing_results.txt 

As we discussed in our earlier presentation, SV are often detected by looking for variations in library insert sizes. The stdout of . Look at the preprocessing_results.txt file created by the pearl script will answer the questions:

...

Note
titleThis is one of the most common mistakes people make during the course and the nature of zoom make this very likely to be true this year as well

Notice the next block contains line numbers. On lines 7 and 8 you see ##### and <USERNAME> ... these need to correspond to your scratch directory locations. You can easily check this with the pwd command.

Do not change anything else on the line.

If you are unsure what you should be replacing those place holders with please get my attention on zoom and I'll help you through it.


Code Block
titleCreate Using nano, create the file svdetect.conf with this text
linenumberstrue
<general>
input_format=sam
sv_type=all
mates_orientation=RF
read1_length=35
read2_length=35
mates_file=/scratch/#####/<USERNAME>/GVA_sv_tutorial/61FTVAAXX.ab.sam
cmap_file=/scratch/#####/<USERNAME>/GVA_sv_tutorial/NC_012967.1.lengths
num_threads=48
</general>

<detection>
split_mate_file=0
window_size=20005000
step_length=10002500
</detection>

<filtering>
split_link_file=0
nb_pairs_threshold=37
strand_filtering=1
insert_size_filtering=1
mu_length=unknown1
sigma_length=unknown2
order_filtering=1
nb_pairs_order_threshold=5
</filtering>

<bed>
  <colorcode>
    255,0,0=1,4
    0,255,0=5,10
    0,0,255=11,100000
  </colorcode>
</bed>

The following commands will take a few minutes each and must be completed in order, so no advantages/ability to have them run in the background. Consult the manual for a full description of what these commands and options are doing while the commands are running.

Code Block
titleCommands to run SNVDetect
SVDetect linking -conf svdetect.conf
SVDetect filtering -conf svdetect.conf
SVDetect links2SV -conf svdetect.conf

Each command will finish faster than the one before it with the longest period with no advancement seeming to be after "# Defining precise link coordinates..." is printed to the screen.

...

titleCheat Sheat

If you decide that SVdetect is the program you would like to use for calling your structural variants the following 1 line command will become invaluable:

SVDetect linking -conf svdetect.conf && SVDetect filtering -conf svdetect.conf && SVDetect links2SV -conf svdetect.conf && echo "SVDetect finished without Errors"

...

Take a look at the final output file: 61FTVAAXX.ab.sam.links.filtered.sv.txt. Another downside of command line applications is that while you can print files to the screen, the formatting is not always the nicest. On the plus side in 95% of cases, you can directly copy the output from the terminal window to excel and make better sense of what the columns actually are

I've highlighted a few lines below:

Code Block
chr_type        SV_type BAL_type        chromosome1     start1-end1     average_dist    chromosome2     start2-end2     nb_pairs        score_strand_filtering  score_order_filtering   score_insert_size_filtering     final_score     breakpoint1_start1-end1 breakpoint2_start2-end2
...
INTRA   NORMAL_SENSE    -       chrNC_012967    599566-601025   -       chrNC_012967    663036-664898   430     100%    -       -       1       -       -
...
INTRA   NORMAL_SENSE    -       chrNC_012967    3-2025  -       chrNC_012967    4627019-4628998 288     100%    -       -       1       -       -
...
INTRA   REVERSE_SENSE   -       chrNC_012967    16999-19033     -       chrNC_012967    2775082-2777014 274     100%    -       -       1       -       -

...

titleAny idea what sorts of mutations produced these three structural variants?

1. This is a tandem head-to-tail duplication of the region from approximately 600000 to 663000.
2. This is just the origin of the circular chromosome, connecting its end to the beginning!
3. This is a big chromosomal inversion mediated by recombination between repeated IS elements in the genome. It would not have been detected if the insert size of the library wasn't > ~1,500 bp!

...

Notice that lines 23 and 24 are listed as unknown1 and unknown2 respectively. While several of the other values are related to the actual library, these 2 values are actually critical to enabling and guiding the analysis (pick too small and even normal reads appear to support structural variants, pick too large and even variant reads appear as normal reads). Luckily these values are actually empirically determined as part of the preprocessing_results.txt file that was created with the perl script.

No Format
-- mu length = 2223, sigma length = 1122

You can either look up the values and replace unknown1 and unknown2 with 2223 and 1122 respectively

Code Block
titleOR take advantage of this one liner which captures the line listed above, pulls the 2 numbers to a pair of variables, and then replaces unknown1 and unknown2 with the correct values in the existing file
mu_sigma=$(grep "^-- mu length = [0-9]*, sigma length = [0-9]*$" preprocessing_results.txt | \
sed -E 's/-- mu length = ([0-9]+), sigma length = ([0-9]+)/\1,\2/'); \
mu=$(echo $mu_sigma | cut -d "," -f 1); \
sigma=$(echo $mu_sigma | cut -d "," -f 2); \
sed -i -E "s/mu_length=unknown1/mu_length=$mu/" svdetect.conf; \
sed -i -E "s/sigma_length=unknown2/sigma_length=$sigma/" svdetect.conf

Note that the above is considered a '1-liner' even though it is spread across 6 lines for clarity. When \ is encountered at the end of the line the command line waits until it reaches the end of a line without finding a "\" before executing anything. As the following commands will take a few minutes each and must be completed in order,  launch them in order, but read ahead as to what values in our svdetect.conf file are critical to analysis, and why we picked the values we did. 

Code Block
titleCommands to run SNVDetect
SVDetect linking -conf svdetect.conf
SVDetect filtering -conf svdetect.conf
SVDetect links2SV -conf svdetect.conf

Each command will finish faster than the one before it with the longest period with no advancement seeming to be after "# Defining precise link coordinates..." is printed to the screen. While waiting:


  • Expand
    titleCritical values and their choice


    optionvaluereason
    mu_length2223this is taken directly from the preprocessing perl script, it enables classification of the different discordant read mappings
    sigma_length1122Again taken from the preprocessing perl script, it enables classification of the different discordant read mappings
    window_size5000Must be set to at least 2mu + (2sigma)0.5 to enable balance classification (4540 would be minimum value in this case)
    step_length2500Documentation suggests this be 25-50% of the window size, smaller sizes enable more precise endpoint determination.
    strand; insert size; ordering_filtering1Setting each to 1 turns on such filtering, absent being listed, or being listed as 0, these tests would not run

    You may also  consult the manual for a full description of what the commands and options inside of the svdetect.conf file.



  • Expand
    titleClick here for a breakdown of what this one liner is doing

    First lets break this one liner down into its 6 parts:

    Code Block
    linenumberstrue
    mu_sigma=$(grep "^-- mu length = [0-9]*, sigma length = [0-9]*$" preprocessing_results.txt | \
    sed -E 's/-- mu length = ([0-9]+), sigma length = ([0-9]+)/\1,\2/'); \
    mu=$(echo $mu_sigma | cut -d "," -f 1); \
    sigma=$(echo $mu_sigma | cut -d "," -f 2); \
    sed -i -E "s/mu_length=unknown1/mu_length=$mu/" svdetect.conf; \
    sed -i -E "s/sigma_length=unknown2/sigma_length=$sigma/" svdetect.conf
    1. Line 1  uses grep on the preprocessing_results.txt file looking for any line that matches "^-- mu length = [0-9]*, sigma length = [0-9]*$" and stores it in a variable mu_sigma.
      1. mu_sigma=$(......) stores everything between the () marks in a command line variable named mu_sigma ... you should notice that the closing ) mark is actually on line 2
      2. the | at the end of the line is the "pipe" command which passes the output to the next command (line in this case as we have broken the command up into parts)
    2. Line 2 uses the sed command to delete everything that is not a number or , and finishes storing the output in the mu_sigma variable
      1. sed commands can be broken down as follows: 's/find/replace/'
        1. in this case, find:
          1. -- mu length = ([0-9]+), sigma length = ([0-9]+)
          2. where :
            1. [0-9] is any number
            2. the + sign means find whatever is to the left 1 or more times
            3. and things between () should be remembered for use in the replace portion of the command
        2. likewise, in this case, replace:
          1. \1,\2/
          2. where
            1. \1 means whatever was between the first set of () marks in the find portion
            2. , is a literal comma
            3. \2 means whatever was between the sescond set of () marks in the find portion
      2. at the end of line 2 we now have a new variable named mu_sigma with a value of "2223,1122"
    3. Line 3 creates a new variable named mu and gives it the value of whatever is to the left of the first , it finds.
      1. echo $mu_sigma |
        1. pass the value of $mu_sigma to whatever is on the other side of |
      2. cut -d "," -f 1
        1. divide whatever the cut command sees at all the "," marks and then print whatever is to the left of the 1st  
      3. at the end of line 3 we now have a variable named mu with the value "2223"
    4. Line 4 does the same thing as line 3 except for a variable named sigma, and takes whatever is between the 2nd comma and 3rd comma (since we only have 1 comma, its taking whatever comes after the comma)
      1. at the end of line 4 we now have a variable named sigma with the value "1122"
    5. Line 5 looks through the entire svdetect.conf file looking for a line that matches mu_length=unknown1 and replaces all that text with mu_length=$mu (except the computer knows $mu is the variable with the value 2223.
      1. the -i option tells the sed command to do the replacement in place meaning you are changing the contents of the file
      2. the "" marks tell the command line that you want to evaluate whatever is between the ""marks, in this case, the mu variable
      3. at the end of line 5, our svdetect.conf file line 23 now reads mu_length=2223
    6. Line 5 looks through the entire svdetect.conf file looking for a line that matches sigma_length=unknown2 and replaces all that text with sigma_length=$sigma (except the computer knows $sigma is the variable with the value 1122.
      1. the -i option tells the sed command to do the replacement in place meaning you are changing the contents of the file
      2. the "" marks tell the command line that you want to evaluate whatever is between the ""marks, in this case, the sigma variable
      3. at the end of line 5, our svdetect.conf file line 24 now reads sigma_length=1122



Tip
titleCheat Sheat

If you decide that SVdetect is the program you would like to use for calling your structural variants the following 1 line command will become invaluable:

SVDetect linking -conf svdetect.conf && SVDetect filtering -conf svdetect.conf && SVDetect links2SV -conf svdetect.conf && echo "SVDetect finished without Errors"

Note that because it is the svdetect.conf file that contains the sample specific information, this is the only command you will ever need for running SVDetect (you will still need to run the preprocessing script and edit the svdetect.conf file for each sample).

The use of the double ampersand (&&) has a special meaning working with piping commands in bash. Specifically it means only do the next command if the previous command finished without errors. By sticking the echo command at the very end you get an easy indicator telling you all the steps of the program finished correctly.


Take a look at the final output file: 61FTVAAXX.ab.sam.links.filtered.sv.txt. Another downside of command line applications is that while you can print files to the screen, the formatting is not always the nicest. On the plus side in 95% of cases, you can directly copy the output from the terminal window to excel and make better sense of what the columns actually are. Unfortunately, this is not one of those times. On Friday I'll explain how I work around this.

I've copied a few of the lines after pasting into excel below :

chr_typeSV_typeBAL_typechromosome1start1-end1average_distchromosome2start2-end2nb_pairsscore_strand_filteringscore_order_filteringscore_insert_size_filteringfinal_scorebreakpoint1_start1-end1breakpoint2_start2-end2
INTRAUNDEFINEDUNBALchrNC_012967624987-629995305chrNC_012967624988-629996320182%100%98%0.821624305-624987629996-630678
INTRAUNDEFINEDUNBALchrNC_012967624699-627533340chrNC_012967624988-628769188985%100%98%0.835621843-624699628769-630678
INTRAUNDEFINEDUNBALchrNC_012967625953-629995321chrNC_012967627473-630044164683%100%97%0.817624305-625953630044-633163
INTRALARGE_DUPLIUNBALchrNC_012967599566-60249863831chrNC_012967662625-666126658100%100%100%1596808-599566666126-668315
INTRALARGE_DUPLIUNBALchrNC_012967599966-60286963804chrNC_012967663105-666126512100%100%100%1597179-599966666126-668795
INTRALARGE_DUPLIUNBALchrNC_0129673-20254627075chrNC_0129674626530-4629804436100%99%100%0.9953-Jan4629804-4629812
INTRAINVERSIONUNBALchrNC_01296717471-201792757879chrNC_0129672774440-2777242237100%100%-114489-174712771552-2774440


Expand
titleAny idea what sorts of mutations produced these three structural variants?
  • The first 5 lines all refer to the same general region from approximately 600000 to 663000 (as do several others lower in the file). This is in fact a head to tail duplication involving citrate utilization. One of the reasons for the multiple lines referring to the same event is that the amplification itself is nested with slight differences in start/stop locations.
  • Line 6 is just the origin of the circular chromosome, connecting its end to the beginning! Some programs allow for flags to denote a sequence as circular to avoid reporting things like this, SVdetect is not one of them.
  • The last line is listed as big chromosomal inversion (possibly mediated by recombination between repeated sequence such as  IS elements in the genome). It was only detected because the insert size of the library was > ~1,500 bp!
  • Alternatively, the last line (or certainly inversions listed lower in the file) may be a  it may be a mobile element jumping into a new location in the genome. 2 key reasons for thinking this may be the case, are 1 there are a lot of inversions listed, but no insertions or translocations, and this is an E coli genome known to have highly active mobile elements. 2 we discussed what MAPQ scores mean in terms of repetitive elements, yet have done no filtering for such elements, and while the inversion listed above has a high number of read pairs supporting it, many of the others do not as you would expect for only some of the copies being randomly assigned among any of the appropriate locations.


Return to GVA2022 course page.