Merge pull request #153 from Kulivox/mergeSTR_harmonization_update

Merge str harmonization update
gymrek-lab · Mar 24, 2022 · 261265f · 261265f
2 parents 8dd9abf + 7aba69c
commit 261265f
Show file tree

Hide file tree

Showing 8 changed files with 325 additions and 100 deletions.
diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst
@@ -1,11 +1,18 @@
 Unreleased changes
 -----
 
-CompareSTR and mergeutils changes:
+Functionality Changes:
+
+* MergeSTR: Decision on which records are able to be merged is now based on data from harmonized TRRecords,
+  and not from the records directly from VCF readers. Thanks to this, HipSTR records which have different starting positions,
+  but position of their repeat is at the same position are merged correctly. This difference is caused by flanking BP that are
+  included in the record. These flanking BPs are also removed during the merge, and merged HipSTR records no longer contain them
 
 * CompareSTR: the tool now only compares records that start and end at the same position. If overlap in records is detected,
   the program will output a warning to the user. This warning contains IDs of the records and their positions.
 
+Misc:
+
 * mergeutils: function GetMinHarmonizedRecords was transformed into GetRecordComparabilityAndIncrement, which allows the caller
   to define custom predicate that decides whether records are comparable.