README.rst 23.6 KB
Newer Older
jhoogenboom's avatar
jhoogenboom committed
1
2
3
4
5
6
7
8
9
Forensic DNA Sequencing Tools
=============================

Tools for filtering and interpretation of Next Generation Sequencing data of
forensic DNA samples. To obtain a list of included tools with a brief
description of each tool, run:

    ``fdstools -h``

10
For a complete description of a specific tool and its command line arguments,
jhoogenboom's avatar
jhoogenboom committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
run:

    ``fdstools -h TOOLNAME``


Installation
------------

The recommended way to install FDSTools is by using the ``pip`` package
installer. If you have ``pip`` installed, you can easily install FDSTools by
typing:

    ``pip install fdstools``

Alternatively, FDSTools can be installed by running:
26

jhoogenboom's avatar
jhoogenboom committed
27
28
29
30
31
    ``python setup.py install``


FDSTools Changelog
------------------
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
v1.1.0
    - Allele name heuristics: don't produce insertions at the end of the prefix
      or at the beginning of the suffix; just include extra STR blocks.
    - FDSTools will no longer crash with a 'column not found' error when
      an input file is empty. This situation is now treated as if the
      expected columns existed, but no lines of actual data were present.
      This greatly helps in tracking down issues in pipelines involving
      multiple tools, as tools will now shutdown gracefully if an upstream
      tool fails to write output.
    - Includes Allelefinder v1.0.1
    - Includes BGAnalyse v1.0.1
    - Includes BGCorrect v1.0.2
    - Includes BGEstimate v1.1.2
    - Includes BGHomRaw v1.0.1
    - Includes BGHomStats v1.0.1
    - Includes BGMerge v1.0.3
    - Includes BGPredict v1.0.2
    - Includes FindNewAlleles v1.0.1
    - Includes Libconvert v1.1.2
    - Includes Library v1.0.3
    - Includes Pipeline v1.0.3
    - Includes Samplestats v1.1.1
    - Includes Seqconvert v1.0.2
    - Includes Stuttermark v1.5.1
    - Includes Stuttermodel v1.1.2
    - Includes TSSV v1.1.0
    - Includes Vis v1.0.4
    - Includes BGRawvis v2.0.1
    - Includes Profilevis v2.0.1
    - Includes Samplevis v2.2.0
    - Includes Stuttermodelvis v2.0.3

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
v1.0.1
    - Fixed crash that occurred when using the -i option to run the same
      command on multiple input files.
    - The 'usage' line now always starts with 'fdstools', even if FDSTools was
      invoked through some other command (e.g. on Windows, FDSTools gets
      invoked through a file called 'fdstools-script.py').
    - Fixed bug with the -d/--debug option being ignored if placed before the
      tool name on systems running Python 2.7.9 or later.
    - FDSTools library files may now contain IUPAC ambiguous bases in the
      prefix and suffix sequences of STR markers (except the first sequence,
      as it is used as the reference). Additionally, optional bases may be
      represented by lowercase letters.
    - If no explicit prefix/suffix is given for an alias, the prefix/suffix of
      the corresponding marker is assumed instead. This situation was not
      handled correctly when converting from raw sequences to TSSV or
      allelename format, which resulted in the alias remaining unused.
    - Includes Libconvert v1.1.1
    - Includes Library v1.0.2
    - Includes Pipeline v1.0.2
    - Includes Vis v1.0.3
    - Includes Samplevis v2.1.2
    - Includes Stuttermodelvis v2.0.2

v1.0.0
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    - Fixed bug that caused variant descriptions in allele names of non-STR
      markers to be prepended with plus signs similar to suffix variants
      in STR markers; when attempting to convert these allele names back to raw
      sequences, FDSTools would crash with an 'Invalid allele name' error
    - Tools that take a list of files as their argument (through the -i option
      or as positionals) now explicitly support '*' and '?' wildcards
    - Includes BGEstimate v1.1.1
    - Includes BGMerge v1.0.2
    - Includes Library v1.0.1
    - Includes Pipeline v1.0.1
    - Includes Stuttermodel v1.1.1
    - Includes Allelevis v2.0.1
    - Includes Samplevis v2.1.1
    - Includes Stuttermodelvis v2.0.1

103
104
105
106
107
108
109
110
111
112
113
114
115
v0.0.5
    - The Blame tool was removed in favour of BGAnalyse
    - Includes BGAnalyse v1.0.0
    - Includes Libconvert v1.1.0
    - Includes Library v1.0.0
    - Includes Pipeline v1.0.0
    - Includes Samplestats v1.1.0
    - Includes TSSV v1.0.2
    - Includes Vis v1.0.2
    - Includes Allelevis v2.0.0
    - Includes BGAnalysevis v1.0.0
    - Includes BGRawvis v2.0.0
    - Includes Profilevis v2.0.0
116
    - Includes Samplevis v2.1.0
117
118
    - Includes Stuttermodelvis v2.0.0

119
120
v0.0.4
    - FDSTools will now print profiling information to stdout when the
121
      -d/--debug option was specified
122
123
    - Fixed bug where specifying '-' as the output filename would be taken
      literally, while it should have been interpreted as 'write to standard
124
125
      out' (Affected tools: BGCorrect, Samplestats, Seqconvert, Stuttermark)
    - Added more detailed license information to FDSTools
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
    - Updated bundled JavaScript library Vega to v2.6.0
    - Updated bundled JavaScript library D3 to v3.5.17
    - Includes BGCorrect v1.0.1
    - Includes BGEstimate v1.1.0
    - Includes BGMerge v1.0.1
    - Includes BGPredict v1.0.1
    - Includes Libconvert v1.0.1
    - Includes Samplestats v1.0.1
    - Includes Seqconvert v1.0.1
    - Includes Stuttermodel v1.1.0
    - Includes TSSV v1.0.1
    - Includes Vis v1.0.1
    - Includes Allelevis v1.0.0beta2
    - Includes BGRawvis v1.0.1
    - Includes Profilevis v1.0.1
    - Includes Samplevis v2.0.1
    - Includes Stuttermodelvis v1.0.0beta2

144
v0.0.3
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
    - Updated bundled JavaScript library Vega to v2.5.0
    - Updated bundled JavaScript library D3 to v3.5.12
    - Includes Allelefinder v1.0.0
    - Includes BGCorrect v1.0.0
    - Includes BGEstimate v1.0.0
    - Includes BGHomRaw v1.0.0
    - Includes BGHomStats v1.0.0
    - Includes BGMerge v1.0.0
    - Includes BGPredict v1.0.0
    - Includes Blame v1.0.0
    - Includes FindNewAlleles v1.0.0
    - Includes Libconvert v1.0.0
    - Includes Samplestats v1.0.0
    - Includes Seqconvert v1.0.0
    - Includes Stuttermark v1.5.0
    - Includes Stuttermodel v1.0.0
    - Includes TSSV v1.0.0
    - Includes Vis v1.0.0
    - Includes Allelevis v1.0.0beta1
    - Includes BGRawvis v1.0.0
    - Includes Profilevis v1.0.0
    - Includes Samplevis v2.0.0
    - Includes Stuttermodelvis v1.0.0beta1
168

jhoogenboom's avatar
jhoogenboom committed
169
170
171
172
v0.0.2
    - Added global -d/--debug switch
    - Includes Stuttermark v1.4

jhoogenboom's avatar
jhoogenboom committed
173
174
175
176
177
v0.0.1
    - Initial version
    - Includes Stuttermark v1.3


178
179
Allelefinder
~~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
180
181
182
183
184
v1.0.1
    - Fixed crash that occurred when converting sequences to allele name format
      when no library file was provided.
    - Shut down cleanly when the output pipe is closed.

185
186
187
188
v1.0.0
    - Initial version


189
190
BGAnalyse
~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
191
192
193
v1.0.1
    - Shut down cleanly when the output pipe is closed.

194
195
196
197
v1.0.0
    - Initial version


198
BGCorrect
jhoogenboom's avatar
jhoogenboom committed
199
~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
200
201
202
203
v1.0.2
    - Don't crash on empty input files.
    - Shut down cleanly when the output pipe is closed.

204
205
206
207
208
v1.0.1
    - Added new column 'weight' to the output. The value in this column
      expresses the number of times that the noise profile of that allele
      fitted in the sample.

209
210
211
212
213
214
v1.0.0
    - Initial version


BGEstimate
~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
215
216
217
v1.1.2
    - Shut down cleanly when the output pipe is closed.

218
219
220
221
222
v1.1.1
    - Added option -p/--profiles which can be used to provide a previously
      created background noise profiles file, from which starting values will
      be read instead of assuming zero noise

223
224
225
226
227
228
229
230
231
232
233
234
v1.1.0
    - Added a new option -g/--min-genotypes (default: 3). Only alleles that
      occur in at least this number of unique heterozygous genotypes will be
      considered. This is to avoid 'contamination' of the noise profile of one
      allele with the noise of another. If homozygous samples are available for
      an allele, this filter is not applied to that allele. Setting this option
      to 1 effectively disables it. This option has the same cascading effect
      as the -s/--min-samples option, that is, if one allele does not meet the
      threshold, the samples with this allele are excluded which may cause some
      of the other alleles of these samples to fall below the threshold as
      well.

235
236
237
238
239
240
v1.0.0
    - Initial version


BGHomRaw
~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
241
242
243
244
245
v1.0.1
    - Clarified the 'Allele x of marker y has 0 reads' error message with the
      name of the sample that triggered the error.
    - Shut down cleanly when the output pipe is closed.

246
247
248
249
250
251
v1.0.0
    - Initial version


BGHomStats
~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
252
253
254
255
256
v1.0.1
    - Error messages about the input data now contain the name of the sample
      that triggered the error.
    - Shut down cleanly when the output pipe is closed.

257
258
259
260
261
262
v1.0.0
    - Initial version


BGMerge
~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
263
264
265
v1.0.3
    - Shut down cleanly when the output pipe is closed.

266
267
268
v1.0.2
    - Minor changes to facilitate explicit filename wildcard support

269
270
271
v1.0.1
    - Reduced memory usage

272
273
274
275
276
277
v1.0.0
    - Initial version


BGPredict
~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
278
279
280
281
v1.0.2
    - Don't crash on empty input files.
    - Shut down cleanly when the output pipe is closed.

282
283
284
285
286
287
288
289
v1.0.1
    - Greatly reduced memory usage.
    - BGPredict will now output nonzero values below the threshold set by
      -n/--min-pct if the predicted noise ratio of the same stutter on the
      other strand is above the threshold. Previously, values below the
      threshold were clipped to zero, which may cause unnecessarily high strand
      bias in the predicted profile.

290
291
292
293
294
295
v1.0.0
    - Initial version


FindNewAlleles
~~~~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
296
297
298
299
v1.0.1
    - Don't crash on empty input files.
    - Shut down cleanly when the output pipe is closed.

300
301
302
303
304
305
v1.0.0
    - Initial version


Libconvert
~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
306
307
308
309
v1.1.2
    - Shut down cleanly when the output pipe is closed.

v1.1.1
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
310
311
312
    - Adjustments for supporting IUPAC notation in prefix and suffix sequences
      when converting from FDSTools to TSSV library format.

313
314
315
316
317
318
319
320
321
322
323
324
v1.1.0
    - When converting to FDSTools format, Libconvert automatically creates an
      empty FDSTools library file with the same contents as what would be
      obtained from the new Library tool without arguments.
    - The -a/--aliases option was modified such that it has the same effect as
      the -a/--aliases option of the new Library tool. This means that without
      this option specified, the [aliases] section will not be present in the
      output anymore.
    - The ability of the Libconvert tool to produce an empty FDSTools library
      file if no input file was given has been removed from the documentation
      (but not from the tool itself).

325
326
327
328
329
v1.0.1
    - Specifying '-' as the first positional argument to libconvert will now
      correctly interpret this as "read from stdin" instead of throwing a "file
      not found" error (or reading from a file named "-" if it exists)

330
331
332
333
v1.0.0
    - Initial version


334
335
Library
~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
336
337
338
v1.0.3
    - Shut down cleanly when the output pipe is closed.

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
339
340
341
342
v1.0.2
    - Added documentation for IUPAC support to the descriptive comment of the
      [prefix] section.

343
344
345
346
v1.0.1
    - Updated some of the comments describing the sections
    - Added proper examples for non-STR markers and aliases

347
348
349
350
351
352
v1.0.0
    - Initial version


Pipeline
~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
353
354
355
356
v1.0.3
    - Fixed glitch that caused the 'bgprofiles.html' output file of the
      reference-database analysis to lack a proper title.

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
357
358
359
360
361
v1.0.2
    - Added -A/--in-allelelist option, with which an existing allele list file
      can be provided when running the reference-database analysis pipeline,
      bypassing Allelefinder.

362
363
364
365
366
367
v1.0.1
    - Removed checking of the existence of the files specified for the
      -S/--in-samples option; instead, this is left to the downstream tools to
      find out, consistent with how this works with other input file options
    - Only output the running commands if the -d/--debug option was specified

368
369
370
371
v1.0.0
    - Initial version


372
373
Samplestats
~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
374
375
376
377
v1.1.1
    - Don't crash on empty input files.
    - Shut down cleanly when the output pipe is closed.

378
379
380
381
382
383
v1.1.0
    - Changed default allele calling option thresholds:
        - Changed default value of -m/--min-pct-of-max from 5.0 to 2.0
        - Changed default value of -p/--min-pct-of-sum from 3.0 to 1.5
    - Mentioned allele calling in the tool descriptions

384
385
386
387
388
389
390
391
392
393
394
395
396
397
v1.0.1
    - Samplestats will now round to 4 or 5 significant digits if a value is
      above 1000 or 10000, respectively. Previously, this was only done for the
      combined 'Other sequences' values
    - The 'Other sequences' lines will now also include values for
      total_recovery, forward_recovery, and reverse_recovery
    - The total_recovery, forward_recovery, and reverse_recovery columns are no
      longer placed to the left of all the other columns generated by
      Samplestats
    - The help text for Samplestats erroneously listed the X_recovery_pct
      instead of X_recovery
    - Added support for the new 'weight' column produced by BGCorrect when the
      -a/--filter-action option is set to 'combine'

398
399
400
401
402
403
v1.0.0
    - Initial version


Seqconvert
~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
404
405
406
v1.0.2
    - Shut down cleanly when the output pipe is closed.

407
408
409
410
411
412
v1.0.1
    - Internal naming of the first positional argument was changed from
      'format' to 'sequence-format'. This was done for consistency with the
      -F/--sequence-format option in other tools, giving it the same name in
      Pipeline configuration files.

413
414
v1.0.0
    - Initial version
jhoogenboom's avatar
jhoogenboom committed
415

416
417
418

Stuttermark
~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
419
420
421
422
v1.5.1
    - Don't crash on empty input files.
    - Shut down cleanly when the output pipe is closed.

423
v1.5.0
424
    - Changed column names 'name' and 'allele' to 'marker' and 'sequence',
425
      respectively. WARNING: Stuttermark is now INCOMPATIBLE with output
426
427
      from TSSV_ but made compatible with TSSV-Lite and the new, bundled TSSV
      tool instead.
428

429
v1.4.0
jhoogenboom's avatar
jhoogenboom committed
430
431
432
433
434
    - Stuttermark now accepts raw sequences and allele names as input, which
      are automatically rewritten as TSSV-style sequences using a specified
      library file
    - The 'name' column is now optional

435
v1.3.0
jhoogenboom's avatar
jhoogenboom committed
436
437
438
439
    - First version of Stuttermark to be included in ``fdstools``
    - Fixed crash that occurred when an empty allele (e.g., a primer dimer)
      was encountered
    - Stuttermark now prints a warning if an allele is encountered that is
jhoogenboom's avatar
jhoogenboom committed
440
      not a TSSV_-style sequence
jhoogenboom's avatar
jhoogenboom committed
441

442
v1.2.0
jhoogenboom's avatar
jhoogenboom committed
443
444
445
    - All settings are now available from the command line
    - Use 1-based indexing in ``STUTTER`` annotations

446
v1.1.0
jhoogenboom's avatar
jhoogenboom committed
447
448
449
    - Stuttermark now accepts file names and the minimum number of reads to
      evaluate as command line arguments

450
v1.0.0
jhoogenboom's avatar
jhoogenboom committed
451
452
453
    - Initial version


454
455
Stuttermodel
~~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
456
457
458
v1.1.2
    - Shut down cleanly when the output pipe is closed.

459
460
461
v1.1.1
    - Minor change to internal variant representation

462
463
464
465
466
467
468
469
v1.1.0
    - Stuttermodel will now only output a fit for one strand if it could also
      obtain a fit for the other strand (for the same marker, unit, and stutter
      depth). This new behaviour can be disabled with a new -O/--orphans
      option.
    - Fixed bug that caused Stuttermodel to output only the raw data points for
      -1 and +1 stutter when normal output was supressed

470
471
v1.0.0
    - Initial version
jhoogenboom's avatar
jhoogenboom committed
472
473


474
475
TSSV
~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
476
477
478
479
480
v1.1.0
    - Added option '-T/--num-threads' (default: 1), which controls the number
      of worker threads TSSV may spawn to run the analysis in parallel.
    - Shut down cleanly when the output pipe is closed.

481
482
483
484
485
486
v1.0.2
    - Added new option -n/--indel-score which can be used to increase the
      penalty given to insertions and deletions in the flanking sequences
      w.r.t. the penalty given to mismatches.
    - NOTE: Requires TSSV v0.4.0 or newer to be installed.

487
488
489
490
491
492
v1.0.1
    - Renamed the '--is_fastq' option to '--is-fastq', which was the only
      option with an underscore instead of a hyphen in FDSTools
    - Fixed crash that would occur if -F/--sequence-format was set to anything
      other than 'raw'

493
494
v1.0.0
    - Initial version
jhoogenboom's avatar
jhoogenboom committed
495
496


497
498
Vis
~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
499
500
501
v1.0.4
    - Shut down cleanly when the output pipe is closed.

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
502
503
504
505
506
507
v1.0.3
    - The -n/--min-abs and -s/--min-per-strand options now accept non-integer
      values as well.
    - Added six options to control the Table Filtering Options of Samplevis.
    - Grouped some options as 'Display Options' in the command line help.

508
509
510
511
512
513
v1.0.2
    - Changed default value of -n/--min-abs from 15 to 5
    - Added -I/--input2 option, which allows for specifying a file with raw
      data points for Stuttermodelvis and Profilevis
    - Added support for creating BGAnalysevis visualisations

514
515
516
517
518
v1.0.1
    - Added -j/--jitter option for Stuttermodelvis (default: 0.25)
    - Fixed bug where Vis would not allow the -n/--min-abs and the
      -s/--min-per-strand options to be set to 0

519
520
v1.0.0
    - Initial version
jhoogenboom's avatar
jhoogenboom committed
521
522


523
524
Allelevis
~~~~~~~~~
525
526
527
v2.0.1
    - Added tooltip support to HTML visualisations

528
529
530
531
532
533
534
v2.0.0
    - Replaced the simple Options overlay with responsive design options panels
      in HTML visualisations
    - Reduced Vega graph spec complexity by using the new Rank transform to
      position the subgraphs
    - Fixed glitch that caused unnecessary padding around the graph

535
536
537
538
539
540
541
542
v1.0.0beta2
    - Fixed potential crash/corruption that could occur with very unfortunate
      combinations of sample names and marker names
    - HTML visualisations made with the -O/--online option of the Vis tool will
      now contain https URLs instead of http
    - Added two more colours to the legend, such that a maximum of 22 markers
      is now supported without re-using colours

543
544
545
v1.0.0beta1
    - Initial version

jhoogenboom's avatar
jhoogenboom committed
546

547
548
549
550
551
552
BGAnalysevis
~~~~~~~~~~~~
v1.0.0
    - Initial version


553
554
BGRawvis
~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
555
556
557
558
559
560
v2.0.1
    - Changed default save filename in HTML visualisations to 'bgprofiles-raw'.
    - Fixed glitch where, in HTML visualisations with embedded data and a
      custom title, the custom title was truncated to the last '.' as if it
      were a file name.

561
562
563
564
565
566
567
v2.0.0
    - Replaced the simple Options overlay with responsive design options panels
      in HTML visualisations
    - Sequences are now sorted by CE allele length when applicable
    - Changed default minimum number of reads from 15 to 5
    - Added marker selection menu for easier filtering

568
569
570
571
572
573
574
575
576
v1.0.1
    - Fixed a JavaScript crash that would occur in HTML visualisations if the
      Marker name filter resulted in an invalid regular expression (e.g., when
      the entered value ends with a backslash)
    - Reduced Vega graph spec complexity by using the new Rank transform to
      position the subgraphs
    - HTML visualisations made with the -O/--online option of the Vis tool will
      now contain https URLs instead of http

577
578
579
580
581
582
v1.0.0
    - Initial version


Profilevis
~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
583
584
585
586
587
588
v2.0.1
    - Changed default save filename in HTML visualisations to 'bgprofiles'.
    - Fixed glitch where, in HTML visualisations with embedded data and a
      custom title, the custom title was truncated to the last '.' as if it
      were a file name.

589
590
591
592
593
594
595
v2.0.0
    - Replaced the simple Options overlay with responsive design options panels
      in HTML visualisations
    - Alleles and sequences are now sorted by CE allele length when applicable
    - Added option to plot BGHomRaw data on top of the profiles
    - Added marker selection menu for easier filtering

596
597
598
599
600
601
602
603
604
v1.0.1
    - Fixed a JavaScript crash that would occur in HTML visualisations if the
      Marker name filter resulted in an invalid regular expression (e.g., when
      the entered value ends with a backslash)
    - Reduced Vega graph spec complexity by using the new Rank transform to
      position the subgraphs.
    - HTML visualisations made with the -O/--online option of the Vis tool will
      now contain https URLs instead of http

605
606
607
608
609
610
v1.0.0
    - Initial version


Samplevis
~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
611
612
613
614
615
616
617
v2.2.0
    - Fixed incorrect calculation of 'percentage of highest' if the 'sequence'
      with the highest read count within a marker is the aggregated 'Other
      sequences' data. In exceptional cases, this could have resulted in the
      erroneous omission of an allele in the visualisation (graphs and/or
      tables).

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
618
619
620
621
622
623
624
v2.1.2
    - Added 'Save page' link to HTML visualisations, which offers for download
      a copy of the entire HTML visualisation including the user's changes.
    - Added automatic allele calling to static visualisations.
    - The net effect of the allele calling thresholds (table filtering options)
      is now visualised in the graphs as a dashed vertical red line.

625
626
627
628
629
630
631
632
633
634
635
636
637
638
v2.1.1
    - Added tooltip support to HTML visualisations
    - The tooltip may include a 'new allele' note if the input sample was
      analysed with FindNewAlleles
    - The allele tables in HTML visualisations will now grow much wider than
      before if the screen (or window) is very narrow
    - Improved line breaking behaviour in the tables in HTML visualisations
    - Improved determination of column widths of the allele tables when
      printing an HTML visualisation
    - When printing an HTML visualisation, the graph and the corresponding
      table of a marker will be kept on the same page in all browsers now
    - Fixed glitch that caused 'Infinity%' or 'NaN%' to be written in some
      cells in the allele tables in HTML visualisations

639
640
641
642
643
644
645
v2.1.0
    - Changed default minimum number of reads for graph filtering from 15 to 5
    - Changed default table filtering options:
        - Percentage of highest allele per marker changed from 5% to 2%
        - Percentage of the marker's total reads changed from 3% to 1.5%
        - Minimum number of reads in both orientations changed from 0 to 1

646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
v2.0.1
    - Fixed a JavaScript crash that would occur in HTML visualisations if the
      Marker name filter resulted in an invalid regular expression (e.g., when
      the entered value ends with a backslash)
    - Reduced Vega graph spec complexity by using the new Rank transform to
      position the subgraphs
    - Fixed a glitch in HTML visualisations where clicking the 'Truncate
      sequences to' label would select the marker spacing input
    - In HTML visualisations, the 'Notes' table cells with 'BGPredict' in them
      now get a light orange background to warn the user that their background
      profile was computed. If a sequence was explicitly 'not corrected', 'not
      in ref db', or 'corrected as background only', the same colour is used.
    - The message bar at the bottom of Samplevis HTML visualisations will now
      grow no larger than 3 lines. A scroll bar will appear as needed.
    - HTML visualisations made with the -O/--online option of the Vis tool will
      now contain https URLs instead of http

663
664
665
666
667
668
v2.0.0
    - Initial version


Stuttermodelvis
~~~~~~~~~~~~~~~
Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
669
670
671
672
673
674
675
v2.0.3
    - Fixed bug that caused HTML visualisations with embedded data to fail
      while loading.
    - Fixed glitch where, in HTML visualisations with embedded data and a
      custom title, the custom title was truncated to the last '.' as if it
      were a file name.

Hoogenboom, Jerry's avatar
Hoogenboom, Jerry committed
676
677
678
679
680
v2.0.2
    - Added filtering option for the stutter amount (-1, +1, -2, etc.).
    - Added filtering option for the coefficient of determination (r squared
      value) of the fit functions.

681
682
683
v2.0.1
    - Changed the unit in the horizontal axis title from 'bp' to 'nt'

684
685
686
687
688
689
690
691
692
v2.0.0
    - Replaced the simple Options overlay with responsive design options panels
      in HTML visualisations
    - Fixed glitch that caused the graphs to be re-rendered twice when loading
      a file by drag-and-drop in HTML visualisations
    - Fixed glitch that made it possible to replace the data that was embedded
      in an HTML visualisation through drag-and-drop
    - Added repeat unit selection menu for easier filtering

693
694
695
696
697
698
699
700
701
702
703
704
v1.0.0beta2
    - HTML visualisations now support drawing raw data points on top of the fit
      functions. The points can be drawn with an adjustable jitter to reduce
      overlap.
    - Fixed a JavaScript crash that would occur in HTML visualisations if the
      Repeat unit or Marker name filter resulted in an invalid regular
      expression (e.g., when the entered value ends with a backslash)
    - Reduced Vega graph spec complexity by using the new Rank transform to
      position the subgraphs.
    - HTML visualisations made with the -O/--online option of the Vis tool will
      now contain https URLs instead of http

705
706
v1.0.0beta1
    - Initial version
jhoogenboom's avatar
jhoogenboom committed
707
708
709


.. _TSSV: https://pypi.python.org/pypi/tssv/