Skip to main content

Forensic DNA Sequencing Tools

Project description

Forensic DNA Sequencing Tools

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

fdstools --help

For a complete description of a specific tool and its command line arguments, run:

fdstools --help TOOLNAME

Installation

FDSTools requires Python version 3.5 or later.

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

pip install -U fdstools

Alternatively, FDSTools can be installed by running:

python setup.py install

Release Notes

Version 2.0.1 (2022-05-12)

Added support for microhaplotype targets. For markers configured as such, the 'allelename' sequence format will look like "MH_AGGTC".

Added ForenSeq DNA Signature Prep Kit library files with ranges specifically optimized for FDSTools (often longer than UAS Flanking Region Report).

Version 2.0.0 (2021-07-15)

Transition to Python 3.5, along with a major upgrade to all tools to provide an overall better experience.

Allele naming is now handled by STRNaming, eliminating the need for complex library files. Library files of commonly-used kits are built in.

Kits that sequence a target on a single strand (such as the ForenSeq DNA Signature Prep Kit by Verogen) are now supported.

Version 1.2.1 (2021-07-15)

This release focuses on finishing support for Python2 before the transition to Python3. FDSTools will now display the help page if no command is given. A message about the transition to Python3 in the next version of FDSTools is added to the command-line help pages. Furthermore, dependency version numbers have been updated to ensure smooth installation on Python2 as well as a smooth transition to Python3.

Version 1.2.0 (2019-03-29)

Major improvements and fixes to the TSSV tool. Most notably, it no longer relies on the external tssvl program because that is no longer compatible with FDSTools. Furthermore, the new TSSV tool v2.0.0 comes with a major performance upgrade and has some updated command-line arguments.

This release also fixes an issue in Samplestats and adds the ability to apply graph filtering before noise correction in Samplevis, making the effects of noise correction more apparent.

Version 1.1.1 (2017-03-15)

Fixeds incorrect calculation of tLeft, fLeft, rLeft, tRight and fRight columns in the report output file of TSSV, when -T/--num-threads was set to 2 or higher. The primary output was unaffected.

Version 1.1.0 (2017-03-14)

In STR allele names for sequences that don't exactly match the description given in the library file, no more insertions are produced at the end of the prefix or the beginning of the suffix, in favour of extra STR blocks.

Empty input files and broken pipelines are now handled gracefully across all tools. Specifically, an empty input file 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. Only the failing tool will output an error.

Furthermore, a new option has been added to the TSSV tool, enabling multithreading support. This can greatly reduce analysis time by using more (or all) cores of the system's processor simultaneously.

Finally, various small bugs and glitches were fixed.

Version 1.0.1 (2016-12-21)

FDSTools library files may now contain IUPAC ambiguous bases in the prefix 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.

An option was added to the Pipeline tool to skip running Allelefinder, using a user-supplied allele list file instead. Multiple options have been added to the Vis tool and some have been regrouped to more easily find the option you are looking for.

It is now possible to save the a Samplevis HTML visualisation after having made changes, preserving the changes made.

And various minor bug fixes and improvements throughout.

Version 1.0.0 (2016-10-03)

Fixed an issue with variant descriptions in allele names of non-STR markers that made it impossible to convert those back to raw sequences.

Added various useful options. Most notably, Samplevis now displays a tooltip when the mouse pointer is over an allele, providing various details about that allele.

And various minor bug fixes.

Version 0.0.5 (2016-09-06)

Added the Library tool, for creating a template library file that includes helpful commentary and examples to get new users started. Creating an empty library file used to be a somewhat confusing option in the Libconvert tool. Also, the Blame tool was replaced with the more advanced BGAnalyse tool.

Added the Pipeline tool, which implements some ready-made pipelines involving most of the other tools in FDSTools. Three pipelines are provided: one for noise reference sample analysis, one for case sample analysis, and one for generating a background noise database from the reference samples.

In Samplestats, the default allele calling option thresholds have changed: - 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

The TSSV tool was updated with an option to increase the penalty given to insertions and deletions in the flanking sequences. It now requires TSSV version 0.4.0 to be installed.

Various upgrades to visualisations, bringing a new responsive design to all HTML visualisations and fixing various issues.

Version 0.0.4 (2016-07-26)

Improved debugging: FDSTools will now print profiling information to stdout when the -d/--debug option was specified. Also, all tools now correctly interpret '-' as the output filename as 'write to standard out'.

BGEstimate has gained a new option to require a minimum number of unique genotypes in which a specific allele must have been seen before it will be considered for noise estimation. 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.

Reduced the memory usage of BGPredict and BGMerge. Also, 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. Similarly, by default Stuttermodel will no longer output a fit on one strand if no fit could be optained on the other strand.

Changes have been made to rounding and column order in Samplestats.

Various minor fixes and enhancements have been made, mostly to the visualisations.

Version 0.0.3 (2016-02-02)

First version of FDSTools with all strings attached. Introduces 15 new tools and five visualisations.

In Stuttermark, the column names 'name' and 'allele' have been changed to 'marker' and 'sequence', respectively, reflecting those of all the other tools. WARNING: Stuttermark is now INCOMPATIBLE with output from TSSV, but made compatible with TSSV-Lite and the new, bundled TSSV tool instead.

Version 0.0.2 (2015-07-23)

Added a new global option: -d/--debug. This option disables the suppression of technical details that would normally be visible when an error occurs.

Stuttermark now accepts raw sequences and allele names as input, which are automatically rewritten as TSSV-style sequences using a specified library file. Also, the 'name' column is now optional.

Version 0.0.1 (2015-07-02)

Initial version of FDSTools, featuring a single tool: Stuttermark v1.3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fdstools-2.0.1.tar.gz (331.5 kB view details)

Uploaded Source

Built Distributions

fdstools-2.0.1-cp310-cp310-win_amd64.whl (359.8 kB view details)

Uploaded CPython 3.10Windows x86-64

fdstools-2.0.1-cp310-cp310-win32.whl (358.9 kB view details)

Uploaded CPython 3.10Windows x86

fdstools-2.0.1-cp39-cp39-win_amd64.whl (359.8 kB view details)

Uploaded CPython 3.9Windows x86-64

fdstools-2.0.1-cp39-cp39-win32.whl (358.9 kB view details)

Uploaded CPython 3.9Windows x86

fdstools-2.0.1-cp38-cp38-win_amd64.whl (359.8 kB view details)

Uploaded CPython 3.8Windows x86-64

fdstools-2.0.1-cp38-cp38-win32.whl (358.9 kB view details)

Uploaded CPython 3.8Windows x86

fdstools-2.0.1-cp37-cp37m-win_amd64.whl (359.8 kB view details)

Uploaded CPython 3.7mWindows x86-64

fdstools-2.0.1-cp37-cp37m-win32.whl (358.9 kB view details)

Uploaded CPython 3.7mWindows x86

fdstools-2.0.1-cp36-cp36m-win_amd64.whl (360.5 kB view details)

Uploaded CPython 3.6mWindows x86-64

fdstools-2.0.1-cp36-cp36m-win32.whl (359.4 kB view details)

Uploaded CPython 3.6mWindows x86

fdstools-2.0.1-cp35-cp35m-win_amd64.whl (360.5 kB view details)

Uploaded CPython 3.5mWindows x86-64

fdstools-2.0.1-cp35-cp35m-win32.whl (359.3 kB view details)

Uploaded CPython 3.5mWindows x86

File details

Details for the file fdstools-2.0.1.tar.gz.

File metadata

  • Download URL: fdstools-2.0.1.tar.gz
  • Upload date:
  • Size: 331.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1.tar.gz
Algorithm Hash digest
SHA256 7833740444aaa9441d247bd626dbe026d93af3ba1725e21665ed2f4accf22055
MD5 a167e6cbe76d14c5ac5fd3ffd43f7930
BLAKE2b-256 3d820a8f6a0e94f60902b5ad85f8e3199e04b272908249f173ac3e82193971c0

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 359.8 kB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 f709250c00accc78e683c9544ea83245067c6cd16bafc6bcb0c24aa458adce7b
MD5 0434f48da6a0e79ee745dc2dfc2ee9ed
BLAKE2b-256 3c24491da505edacd3ea7ee4150a8aed83f2b2ac48914eb9afd6d31457288a3f

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp310-cp310-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp310-cp310-win32.whl
  • Upload date:
  • Size: 358.9 kB
  • Tags: CPython 3.10, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp310-cp310-win32.whl
Algorithm Hash digest
SHA256 3e71e263080ffaa6de7207d8d130c27fb8b3c474026cf3302fbd6803aac39de4
MD5 2b01028393f418d6ed0f3f3e4df9d80a
BLAKE2b-256 47dbff285aa8a938361ccf017fe01c892b013b755d09aed1b2add46f2f4979f5

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 359.8 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 813d88f9bc5942cd8b3bbde7c890d31fdc2747273896563c24331445cdbd8614
MD5 207afab06fac0ee4940c014f36f6d0a6
BLAKE2b-256 40aaef08bcd9d5289f8fbd1283ddedd7b7e58b9d04355a9e4db9670fde6f2efc

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp39-cp39-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp39-cp39-win32.whl
  • Upload date:
  • Size: 358.9 kB
  • Tags: CPython 3.9, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp39-cp39-win32.whl
Algorithm Hash digest
SHA256 0e5f7acebe6582c06987be4b18bcdc0b043b6441e11f6500da2eb6d6d95523fd
MD5 7fd0a6d9fdeef80bf624bbc9d8d5e528
BLAKE2b-256 aa2b07a8f28d565ae7d21ea9b8e954158161029d4469b080718a336a90de722e

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 359.8 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 8f252d2df76d11f14d4cf26905b3fa5a32f73f237822b72df5ee7e87daf7d4dd
MD5 183d9a3edca0290f0b1b8c465afaba67
BLAKE2b-256 0b5e8cd704bc8d224a7db15d86386281c734bcc4bdaf82955ac1b4c9da5d3072

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp38-cp38-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp38-cp38-win32.whl
  • Upload date:
  • Size: 358.9 kB
  • Tags: CPython 3.8, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp38-cp38-win32.whl
Algorithm Hash digest
SHA256 7a8ceefa0e2af8c3a68b0578a867d8697fdf8d524a26235c6e43263d5d25b6ae
MD5 b6b6c16ed1f26fee4f5dffc8e3efc46f
BLAKE2b-256 29fe05d81740b6da142b31ec47f9adce07b5d9601472c105a5154ff7a7ad794c

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 359.8 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 2597b0ea1bae7364906293b68a8cb26448dcd180c018ac76ef5dd880e19fd435
MD5 87736a08e982b0ea7c7474bef9af9498
BLAKE2b-256 6a4149c2b6f346a3f36aa18275c96f9ad2b732f84ca692f8cf845c5a94060b50

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp37-cp37m-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp37-cp37m-win32.whl
  • Upload date:
  • Size: 358.9 kB
  • Tags: CPython 3.7m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp37-cp37m-win32.whl
Algorithm Hash digest
SHA256 0d51c31cc09fd62d4bfbb1380d9c6429315f4ead5d2dd4b3a5de06fc8f4e4261
MD5 bc3a5c13ddf9ab74e95a362b95ea3c01
BLAKE2b-256 a7711341874376c8804b7eb1ccf5c54fd8fac28cd493c174475ea94bcc429d81

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 360.5 kB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 b99870fce74b1c2fb8335f857e29e9311bcfac120744b7f31973a619e73399b9
MD5 f2c0c6dcb90521afbadc8d6a241cfd3b
BLAKE2b-256 457416ba651e30884e7de7780fdad1d60d1f39ef1698729a1be66c7d6bd78967

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp36-cp36m-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp36-cp36m-win32.whl
  • Upload date:
  • Size: 359.4 kB
  • Tags: CPython 3.6m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp36-cp36m-win32.whl
Algorithm Hash digest
SHA256 92d5afc57b1e96fda335ba16182d3f51dc4fc4662f23aca55fe26f3355fe263e
MD5 ad06b51f18c23e05e7db429afaa277ad
BLAKE2b-256 a7a4d893324b2cc561b978a44a48f83d7671cca2bd52bea1b697d4eb9abf2264

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp35-cp35m-win_amd64.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp35-cp35m-win_amd64.whl
  • Upload date:
  • Size: 360.5 kB
  • Tags: CPython 3.5m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 3d66c83958f18cfce04ed30572953c215340d414ca384dd3605ddbb527fac2fe
MD5 c4fba7e033eb3cd9c7a709e900d48c94
BLAKE2b-256 37aa18599692b0ad1378332c0831722d4ccb61c72ab0294d2a9825433afec259

See more details on using hashes here.

File details

Details for the file fdstools-2.0.1-cp35-cp35m-win32.whl.

File metadata

  • Download URL: fdstools-2.0.1-cp35-cp35m-win32.whl
  • Upload date:
  • Size: 359.3 kB
  • Tags: CPython 3.5m, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for fdstools-2.0.1-cp35-cp35m-win32.whl
Algorithm Hash digest
SHA256 a1f1d1414b4e32049e91d3fa2cdb8ddea37eb8d666778eb6064a658c3213c6e9
MD5 a504c621ca37f14a3aa5b19bcaa41117
BLAKE2b-256 2a397f0108ca122ff3c119fd8251617ff65cfa641257f54713100ed8f4da9f20

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page