1. 09 Feb, 2017 1 commit
  2. 06 Sep, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      FDSTools v0.0.5: new tools, changed defaults · abba1c04
      Hoogenboom, Jerry authored
      * General changes in v0.0.5:
        * The TSSV tool now depends on version 0.4.0 of TSSV.
        * Added new Pipeline tool that runs one of three default analysis pipelines
          automatically given a configuration file with tool options and input/output
          file names. The three available pipeline options are 'reference-sample',
          analysing a single reference sample with TSSV and Stuttermark;
          'reference-database', analysing a collection of reference samples with
          BGEstimate and Stuttermodel; and 'case-sample', analysing a single case
          sample with TSSV, BGPredict, BGMerge, BGCorrect, and Samplestats.
        * Added new Library tool that creates an empty FDSTools library file. Users
          may optionally specify the intented use of the library (STR markers,
          non-STR-markers, or both). Only the sections that apply to the given types
          of markers will be included in the output. The [aliases] section is not
          included by default, but an option is available to add it.
        * Added new tool BGAnalyse which can be used to analyse the remaining amount
          of noise in reference samples after correction.  This tool is a more
          sensitive successor of the 'Blame' tool.
        * Added new visualisation BGAnalysevis for visualising data obtained from
          BGAnalyse. This visualisation allows for identifying unclean or otherwise
          suboptimal samples by comparing the lowest, highest, and/or total remaining
          noise after correction for each marker in each sample.
        * The Blame tool was removed in favour of BGAnalyse.
      * Libconvert 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).
      * TSSV 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.
      * Vis 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.
      * Profilevis 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.
      * BGRawvis 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.
      * Stuttermodelvis 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.
      * Allelevis 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.
      * Samplestats 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.
      * Samplevis 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.
      abba1c04
  3. 26 Jul, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Various bug fixes and refinements throughout FDSTools · 08cf6ddd
      Hoogenboom, Jerry authored
      * Global changes in v0.0.4:
        * FDSTools will now print profiling information to stdout when the -d/--debug
          option was specified.
        * Fixed bug where specifying '-' as the output filename would be taken
          literally, while it should have been interpreted as 'write to standard out'
          (Affected tools: BGCorrect, Samplestats, Seqconvert, Stuttermark).
        * Added more detailed license information to FDSTools.
      * BGEstimate 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.
      * Stuttermodel 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.
      * BGCorrect 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.
      * Samplestats 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'.
      * BGPredict 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.
      * BGMerge v1.0.1:
        * Reduced memory usage.
      * TSSV v1.0.1:
        * Renamed the '--is_fastq' option to '--is-fastq'. It 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'.
      * Libconvert 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).
      * Seqconvert 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.
      * Vis v1.0.1:
        * Added -j/--jitter option for Stuttermodelvis (default: 0.25).
        * Vis would not allow the -n/--min-abs and the -s/--min-per-strand options to
          be set to 0.
      * Stuttermodelvis 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.
      * Samplevis 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.
        * Fixed a glitch where clicking the 'Truncate sequences to' label would
          select the marker spacing input.
        * 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.
      * BGRawVis 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.
      * Profilevis 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.
      * Allelevis 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.
      * Updated bundled D3 to v3.5.17.
      * Updated bundled Vega to v2.6.0.
      08cf6ddd
  4. 21 Mar, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Fixed Samplevis allele selection glitch, removed TSSV -L · 9565c837
      Hoogenboom, Jerry authored
      Fixed:
      * Fixed a glitch in Samplevis HTML visualisations, where it would fail
        to correctly maintain the user-(de)selected alleles when switching
        Split Markers on or off.
      
      Removed:
      * Removed -L/--check-length option from the TSSV tool, because it had no
        effect. Instead, the TSSV tool will always enforce the expected allele
        lengths specified in the library file. Behaviour has not changed.
      9565c837
  5. 14 Mar, 2016 1 commit
  6. 08 Mar, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Version numbering for everything · da8d1d1b
      Hoogenboom, Jerry authored
      * Turned all '0.1dev' tool version numbers to '1.0.0'.
      * Changed Stuttermark's version number from '1.5' to '1.5.0'.
      * Added version numbers to the visualisations.
      * Updated README.rst to include all tools, but removed the usage details
        of Stuttermark because it is highly impractical to include usage
        details for all tools in the README file. I'll leave that to the
        -h/--help option and the yet-to-write FDSTools User's Handbook.
      da8d1d1b
  7. 07 Mar, 2016 1 commit
  8. 22 Feb, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Fixed a crash in Samplestats, and minor improvements · 13e0d781
      Hoogenboom, Jerry authored
      Fixed:
      * Fixed crash in Samplestats. It would crash if BGCorrect columns were
        present.
      * Fixed glitch in Samplevis that allowed clicking the 'Other sequences'
        bars if the input data already contained the 'Other sequences' entry.
      
      Improved:
      * The TSSV tool will now drop any sequences that contain anything other
        than A, C, T, and G. If the -A option is given, these sequences will
        still be added to the marker aggregates. Many other tools will fail
        when confronted with such invalid sequences, especially when allele
        names need to be generated.
      * In Samplevis, the sequences are now consistently sorted (except for
        some inconsistency caused by a bug in Vega). The sorting is based on
        read counts and is the same as used for the allele tables in Samplevis
        HTML visualisations.
      * Added a comment line that mentions genome build GRCh38 and rCRS to the
        genome_position block in the libconvert output. This is mainly for
        documentation purposes; users are free to change this line if they use
        a different reference.
      * Minor styling changes to Samplevis HTML visualisations.
      13e0d781
  9. 04 Feb, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Updated handling of 'No data' and 'Other sequences' · 9ed2f3d1
      Hoogenboom, Jerry authored
      Improved:
      * Added -A/--aggregate-below-minimum option to the TSSV tool. This will
        add a line with 'Other sequences' to the output summing all sequences
        that were not reported because they had less reads than was specified
        with the -a/--minimum option.
      * Clarified the help text for the -D/--dir option of the TSSV tool.
      
      Fixed:
      * Updated all tools to consistently handle cases where 'No data' or
        'Other sequences' occurs in place of a sequence.
      9ed2f3d1
  10. 02 Feb, 2016 1 commit
    • Hoogenboom, Jerry's avatar
      Big update: Bumped version to v0.0.3 · ebf700a7
      Hoogenboom, Jerry authored
      Updated Stuttermark to v1.5. WARNING: This version of Stuttermark is
      INCOMPATIBLE with output from previous versions of FDSTools and TSSV.
      
      Introducing TSSV-Lite
      * New tool tssv acts as a wrapper around TSSV-Lite (tssvl). Its primary
        purpose is to allow running TSSV-Lite without having to convert the
        FDSTools library to TSSV format, and to offer allelename output. Like
        all other tools in FDSTools, it also works with TSSV library files but
        its allele name generation capabilities are limited in that case.
      
      Changed:
      * TSSV-Lite and the new TSSV tool in FDSTools have two columns renamed
        w.r.t. the original TSSV program: 'name' has been changed to 'marker',
        and 'allele' has been changed to 'sequence'. All tools in FDSTools
        have been updated to use the new column names. This change affects
        Allelefinder, BGCorrect, BGEstimate, BGHomRaw, BGHomStats, BGPredict,
        Blame, Samplestats, Samplevis, Stuttermark, Stuttermodel, and
        Seqconvert. Note that this change will BREAK COMPATIBILITY of these
        tools with old data files.
      
      Fixed:
      * In Samplevis HTML visualisations, the "percentage recovery" table
        filtering option used the absolute number of recovered reads instead.
      * Added PctRecovery to the tables in Samplevis HTML visualisations.
      * BGPredict will now print a nice error message if the -n/--min-pct
        option is set to zero or a negative number, to avoid division by zero.
      * Samplestats would crash if the input file contained the flags column.
      * FDSTools would crash when trying to convert sequences to allele names
        using a TSSV library.
      
      Improved:
      * Libconvert will no longer include duplicate sequences in the STR
        defenition when converting to TSSV format and the reference sequence
        of one of the markers is the same as one of its aliases, or when
        aliases of one marker share one or more prefix or suffix sequences.
      * Updated add_input_output_args() such that the output file is a
        positional argument (instead of -o) for tools that have a single input
        file and no support for batches.
      * Updated add_sequence_format_args() such that the library file can be
        made a required argument.
      * Refined the FDSTools package description, since FDSTools does more
        than just noise filteirng.
      * FDSTools will now do a marginally better job at producing allele names
        for sequences that do not exactly match the provided STR pattern. When
        seeking the longest matching portion of the sequence, it will now also
        test the reversed sequence with a reversed pattern, which sometimes
        yields a longer match. It is still not optimal, though, but some
        refactoring has been done to move away from regular expressions.
      * BGCorrect will now also fill in correction_flags for newly added
        sequences.
      * Adjusted the help text of Samplestats to include the fact that the -c
        and -y options have an OR relation instead of an AND relation.
      * BGCorrect, BGEstimate, BGHomRaw, BGHomStats, BGPredict, and
        Stuttermodel will now ignore special values that may appear in the
        place of a sequence (currently: 'Other sequences' and 'No data').
      
      Removed:
      * The -m/--marker-column and -a/--allele-column arguments of BGPredict
        had no effect and have been removed.
      
      Visualisations:
      * Updated bundled D3 to v3.5.12.
      * In HTML visualisations, if the page is scrolled to the right edge when
        an option is changed that causes the graphs to become wider, the page
        now remains scrolled to the right.
      * Samplevis HTML visualisations:
        * Added 'Clear manually added/removed' link to the table filtering.
        * Reduced flicker of the mouse cursor in Internet Explorer.
        * Added 'Common axis range' checkbox (only available when 'Split
          markers' is off).
        * Added 'Save table' link to save the table of selected alleles to a
          tab-separated file.
        * Added 'PctRecovery' column to the tables of selected alleles.
        * An alert box is now shown when a data file is loaded that contains
          markers that have 'No data'.
        * Added 'Percentage of total reads' to the graph filtering options.
        * Added a note to the table filtering options to explain that the
          minimum percentage correction and recovery have an OR relation.
      ebf700a7