Skip to content

Latest commit

 

History

History
176 lines (112 loc) · 4.12 KB

CHANGELOG.md

File metadata and controls

176 lines (112 loc) · 4.12 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

  • Refactored dimer prediction to look for exact 3' matches (as per Itokawa et al., 2020) with a Tm > 0.

v1.3.2 - 2020-07-28

Added

  • Add primary_only to run report config section
  • Allow inputs with IUPAC ambiguity codes

v1.3.1 - 2020-07-10

Fixed

  • Fix unintended high-gc mode persistance when run as Celery task
  • Fix incorrect parameter name in run report json

v0.3.0 - 2020-07-10

Added

  • Implement high-GC config option
  • Warn user if high-GC detected (without --high-gc option)
  • Include ref counts in run report

Changed

  • Widen default primer size range (min 19, max 34 bp)

Fixed

  • Fix bug where last region could be a duplicate amplicon in opposite pool (no progress)

v1.2.1 - 2020-06-27

Added

  • Add MultiplexScheme parameters to debug log output
  • Add version number to debug log and run report

Changed

  • Improve --amplicon-size help text
  • Move reference info logging into cli

Fixed

  • Fix outpath option in README
  • Fix --amplicon-size % variation in help text

Removed

  • Remove logger name from log file output

v1.2.0 - 2020-06-26

Added

  • Add --pinned, -p option: reverts to designing primers exclusively from first reference
  • Add short option names
  • Add option to pass single target amplicon size and auto-determine a suitable range
  • Add web interface link to README

Changed

  • Switch from Argparse to Click
  • Rename options
  • Allow --amplicon-size, -a to be passed once to set a target size, or twice to set an exact size range
  • Refactor test_cli.py to use CliRunner throughout

Removed

  • Remove argparse
  • Remove non-functional --step-distance option
  • Remove automatic reference sort on length (no longer serves a purpose)

Fixed

  • Fix edge case where last-but-one region steps right, putting last region out of bounds
  • Fix (usually) inconsequential out-by-one error to make Window.slice_end coord inclusive

v1.1.2 - 2020-06-22

Fixed

  • Fix number of reported candidates considered
  • Fix missing exception message where no suitable pair found
  • Fix incorrect logging of --no-sort

v1.1.1 - 2020-06-15

Added

  • Define ProgressTracker interface as abstract base class (to facilitate web interface progress)

Changed

  • Reorganise Region and Window into region.py

v1.1.0 - 2020-06-14

Added

  • Drop secondary references on repeated flank alignment failure
  • Add primary_ref, secondary_refs and excluded_refs to json run report

Changed

  • Reduce complexity of Region find_primers() method
  • Use progress library
  • Add region and considered primers to progress message

Removed

  • DIY progress bar

v1.0.0 - Nighthawk - 2020-06-12

Added

  • Use all reference sequences for primer generation
  • 3' distance-weighted mismatch scoring
  • Avoid stable heterodimers in same pool
  • Sort inputs by length, to make longest the primary by default (--no-sort reverts)
  • Inserts bed file output
  • Run report json output

Changed

  • Infer mismatches from aligned references and primer coordinates
  • Merge mismatch and base primer scoring
  • Generate primers by digesting all references into K-mers at region flanks
  • Use own implementation of Primer3 base penalty algorithm
  • Update parameters for thermodyamic calculations
  • Rationalise the config file
  • Remove any remaining constants from the code base
  • Reduce code complexity
  • Consolidate exception handling
  • Improve candidate sorting to ensure deterministic output.

Removed

  • primer3 FindPrimers function
  • Redundant classes
  • Redundant exceptions

v0.3.0 - Blackbird - 2020-05-21

Added

  • Windows compatibility
  • Tests
  • Valid BED file strand column

Changed

  • Use parasail for alignment
  • Improve stdout and logging
  • Improve code readability
  • Improved CLI
  • Candidate ranking improvements
  • Various bug fixes
  • Speed improvements