CHANGELOG 13.1 KB
Newer Older
Mathieu Giraud's avatar
Mathieu Giraud committed
1

Mathieu Giraud's avatar
Mathieu Giraud committed
2 3
This changelog concerns the algorithmic part (C++) of Vidjil.

Mathieu Giraud's avatar
Mathieu Giraud committed
4
2016-08-06  The Vidjil Team
5
	* New computation of average quality for each representative sequence, inside its window (core/representative.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
6 7
	* New option (-E) to set the e-value for FineSegmenter D segment detection (vidjil.cpp)
	* Safer e-value estimation for D segments (vidjil.cpp)
8 9
	* Raised capacity to 2*10^9 reads (core/segment.cpp, core/fasta.cpp)
	* Better filtering/debug options (-u/-uu/-uuu), keeping interesting reads (vidjil.cpp, core/windowExtractor.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
10
	* Better .vdj.fa header for irregular/incomplete recombinations, 1-based positions (core/segment.cpp)
11
	* Bugs closed (-u files, similarity in .vidjil)
Mathieu Giraud's avatar
Mathieu Giraud committed
12
	* New and updated unit and functional tests, checking again .should-vdj tests
13

Mathieu Giraud's avatar
Mathieu Giraud committed
14 15 16
2016-07-13  The Vidjil Team
	* New json 2016b format, renamed fields 'seg.{5,4,3,evalue}' and 'diversity', 1-based positions (core/segment.cpp)
	* New tool to display and debug alignments between a read and selected V/J genes (tools/vdj_assign.cpp)
17 18 19 20
	* Better test structure and process. The should-vdj tests will be soon moved to their own repository.
	* Bugs closed (build process, affine gaps (core/dynprog.cpp), JUNCTION/CDR3 detection (core/segment.cpp))
	* New and updated functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
21
2016-03-04  The Vidjil Team
22 23 24 25 26
	* Better JUNCTION/CDR3 detection (-3), based on positions of Cys104 and Phe118/Trp118 (core/segment.cpp)
	* Bugs closed (.vidjil output of revcomp'd sequences, computation of Simpson index Ds)
	* Streamlined structure of tests directory
	* New and updated unit and functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
27
2016-02-08  The Vidjil Team
28 29 30 31 32 33 34 35 36 37 38 39 40
	* New default threshold (-z 100), fully analyzing more clones
	* New computation of diversity indices (Shannon, Simpson) (core/windows.cpp)
	* Streamlined KmerSegmenter test (core/affectanalyser.cpp)
	* Safer p-value estimation in KmerSegmenter, taking into account the central region (core/affectanalyser.cpp)
	* New experimental VDDJ detection analysis (-d) (core/segment.cpp)
	* Better FineSegmenter V(D)J designation for inverted genes in unexpected recombination analysis (core/segment.cpp)
	  The unexpected recombination analysis (-2) can now safely be used.
	* Streamlined FineSegmenter handling of V, D and J segments (core/segment.cpp)
	* Faster FineSegmenter (~30%), relying on the KmerSegmenter to select to correct strand (core/segment.cpp)
	* Updated germline genes from IMGT/GENE-DB
	* Bugs closed (.vidjil output for sequences beyond the -z threshold)
	* New and updated unit and functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
41
2015-12-22  The Vidjil Team
42 43 44
	* Better KmerSegmenter, rejecting reads with large alterning V/J zones (core/segment.cpp)
	* Better unsegmentation causes, 'UNSEG only V/J' needs significant V/J fragments (core/segment.cpp)
	* Renamed unsegmentation messages to "only V/5'" and "only J/3'" to avoid confusion (core/segment.h)
45
	* Better unexpected recombination analysis (-2), with a FineSegmenter V(D)J assignation (core/segment.cpp)
46 47 48
	* Faster FineSegmenter (~35%), computing roughly half of the dynamic programming matrix (core/segment.cpp)
	* More flexible handling of badly formatted .fastq files (core/fasta.cpp)
	* New filtering/debug option (-uu), sort unsegmented reads (core/windowExtractor.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
49 50
	* Streamlined json output, removing short codes (vidjil.cpp, core/segment.cpp)
	* Updated and refactored help (doc/algo.org)
51
	* Updated unit and functional tests
Mathieu Giraud's avatar
Mathieu Giraud committed
52
	* Bugs closed (build process, -X with large numbers, -x/-X combined with -c segment, stdout messages)
53

54 55 56
2015-10-08  The Vidjil Team
	* Bug closed (V(D)J assignation when V/D/J segments are close on the negative strand) (core/segment.cpp)

Mathieu Giraud's avatar
Mathieu Giraud committed
57 58
2015-10-05  The Vidjil Team
	* Better FineSegmenter V(D)J assignation, especially when V/D/J segments are close (core/segment.cpp)
59
	* Better e-value computation for FineSegmenter V(D)J assignation (core/segment.cpp)
60
	* Renamed 'UNSEG too few J/V' to 'UNSEG only V/J' to better reflect the actual detection of one part
Mathieu Giraud's avatar
Mathieu Giraud committed
61
	* Refactored tests for V(D)J assignation, allowing flexible patterns, new documentation (doc/should-vdj.org)
62 63 64
	* New tests on sequences with manually curated V(D)J assignations (tests/should-vdj-tests)
	* Bugs closed (no more spurious D in some VJ recombinations, corrected number of deletions around D regions)

Mathieu Giraud's avatar
Mathieu Giraud committed
65
2015-07-21  The Vidjil Team
66 67 68 69 70 71
        * New flexible parameterization of analyzed recombinations through a json file (germline/germlines.data)
        * New experimental unexpected recombination analysis (-4 -e 10) (core/segment.cpp)
        * New threshold for FineSegmenter VJ assignation, with at least 10 matches (core/germline.cpp)
        * Streamlined handling of segmentation methods (core/germline.h, core/segment.cpp)
        * Updated distance matrix computation between all clones (core/similarityMatrix.cpp)
        * New nlohmann json libray to parse and write json files (lib/json.h)
Mathieu Giraud's avatar
Mathieu Giraud committed
72
        * Updated build process, now requiring a C++11 compiler
73 74 75
        * New draft developer documentation (doc/dev.org), updated help and user documentation
        * New and updated unit and functional tests, bugs closed in shouldvdj tests

Mathieu Giraud's avatar
Mathieu Giraud committed
76
2015-06-05  The Vidjil Team
77 78 79 80 81 82
        * New default trim option (-t 100), considering only the relevant ends of the germline genes
        * Better segmentation heuristic when there are few k-mers (core/segment.cpp)
        * Better TRA/TRD locus analysis (-i), including both Vd-(Dd)-Ja and Dd-Ja recombinations (core/germline.cpp)
        * Better incomplete TRD and Dh/Jh analysis (-i), including up/downstream region of D genes (core/germline.cpp)
        * Better computation of the reference length for the coverage information, considering all reads of each clone
        * Better unexpected recombination analysis (-2), with information on the locus used (core/segment.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
83
        * Streamlined again unsegmentation causes and removed delta_{min,max} for the heuristic (core/segment.cpp)
84 85
        * Refactored stats computation (core/read_storage.cpp)
        * Updated build process
Mathieu Giraud's avatar
Mathieu Giraud committed
86 87 88
          The next release will require a C++11 compiler. Static binaries will also be distributed.
        * Updated help (unsegmentation causes, clustering options, -m option)
        * Bugs closed (segmentation with k-mers on the negative strand, e-value computation, clone output on stdout)
89 90
        * New and updated unit and functional tests, and faster functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
91
2015-05-08  The Vidjil Team
92 93 94
        * New default e-value threshold (-e 1.0), improving the segmentation heuristic
        * New default for window length (-w 50), even with -D or with -g, streamlining the window handling
        * Better multi-germline analysis (-g), selecting the best locus on the e-value (core/segment.cpp)
95
        * New experimental trim option (-t), considering only the relevant ends of the germline genes (core/kmerstore.h)
96 97 98 99 100 101 102
        * Streamlined unsegmentation causes, including 'too short for w(indow)'
        * Updated main and debug ouptut
        * Updated help (algo.org, and new locus.org)
        * New option to keep only reads with labeled windows (-F), new combo (-FaW) to filter reads by window
        * Bugs closed (non symmetrical seeds and revcomp)
        * New and updated unit and functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
103
2015-04-09  The Vidjil Team
104
        * New experimental e-value threshold (-e) (core/segment.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
105
        * New experimental unexpected recombination analysis (-2) (core/segment.cpp)
106 107 108 109 110 111 112 113 114 115 116
        * New preview/debug options to stop after a given number of reads (-x), possibly sampled throughout the file (-X)
        * New preview/debug option to output unsegmented reads as clones (-!)
        * New progress bar during computation
        * Better memory management for the reads taken into account for the representative (core/read_storage.cpp)
        * Updated .json output, with k-mer affectation results
        * Updated .json output, with the 'coverage' of the representative (core/representative.cpp)
        * Removed unused code parts as well as some files
        * Updated help, separing basic (-h) and advanced/experimental options (-H)
        * Bugs closed (extended nucleotides and revcomp)
        * New and updated unit and functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
117
2015-03-04  The Vidjil Team
118 119 120 121 122
	* Better multi-germline analysis (-g), returning the best locus for each read (core/segment.cpp)
	  The incomplete rearrangement analysis (-i) can now safely be used.
	  The speed of this multi-germline analysis will be improved in a next release.
	* Faster representative computation (core/read_chooser.cpp)
	* Included tools (tools/*.py) to process .vidjil files
123
	* New statistics on the number of clones (core/germline.cpp)
124
	* New experimental CDR3 detection (-3). We still advise to use IMGT/V-QUEST for better and complete results.
Mathieu Giraud's avatar
Mathieu Giraud committed
125
	* Better debug option -K (.affect), especially in the case of multi-germline analysis
126 127 128
	* Refactored dynamic programming computations (core/dynprog.cpp), experimental affine gaps
	* Removed unused code parts as well as some files
	* Streamlined flag processing in Makefiles
129
	* New mechanism for some functional tests (make shouldvdj)
130
	* New experimental tests from generated recombinations (make shouldvdj_generated)
131
	* New and updated unit and functional tests
132 133 134 135 136 137 138

2015-01-31  The Vidjil Team
	* Better TRG and TRD+ parameters (-g). The multi-germline analysis will again be improved in a next release.
	* New experimental option (-I) to discard common kmers between different germlines (core/germline.cpp)
	* Updated outputs for better traceability (version in .json, germlines on stdout)
	* New mechanism to retrieve germline databases (germline/get-saved-germline)

Mathieu Giraud's avatar
Mathieu Giraud committed
139
2014-12-22  The Vidjil Team
140 141 142 143 144
	* Better multi-germline analysis (-g). This will again be improved in a next release.
	* New experimental incomplete rearrangement analysis (-i)
	* New and updated unit and functional tests
	* Bugs closed (-w 40 when no D germline)

Mathieu Giraud's avatar
Mathieu Giraud committed
145
2014-11-28  The Vidjil Team
146 147
	* New input method, now accepts compressed fasta files with gzip (core/fasta.cpp, gzstream/zlib)
	* Better multi-germline analysis (-g) and documentation. This analysis can now safely be used.
Mathieu Giraud's avatar
Mathieu Giraud committed
148
	* Streamlined input. Option -d is removed, and a germline is required (-V/(-D)/-J, or -G, or -g)
149 150 151 152 153
	* Removed unused code parts as well as some files
	* New and updated unit and functional tests - now more than 80% code coverage
	* New public continuous integration - travis, coveralls
	* Bugs closed (-l, large -r)

Mathieu Giraud's avatar
Mathieu Giraud committed
154
2014-10-22  The Vidjil Team
155
	* Streamlined filtering options (-r/-y/-z), better documented (doc/algo.org)
Mathieu Giraud's avatar
Mathieu Giraud committed
156 157
	* Streamlined output files, option to fix their basename (-b)
	* Updated .data .json output, now in the better documented 2014.10 format (doc/format-analysis.org)
158
	* New experimental multi-germline analysis (-g). This will be improved and documented in a next release.
Mathieu Giraud's avatar
Mathieu Giraud committed
159
	* Faster FineSegmenter with a better memory allocation (core/dynprog.cpp)
160 161 162
	* Refactored main vidjil.cpp, objects storing germlines and statistics (core/germline.cpp, core/stats.cpp)
	* Transferred clustering from clone output to information in .data, again simplifying vidjil.cpp
	* Removed unused code parts as well as some files
Mathieu Giraud's avatar
Mathieu Giraud committed
163
	* New and updated unit and functional tests
164 165
	* Bugs closed

Mathieu Giraud's avatar
Mathieu Giraud committed
166
2014-09-23  The Vidjil Team
167 168 169 170 171
	* Export cause of non-segmentation in the .data
	* New option to output segmented reads (-U), now by default segmented reads are not output one by one
	* Updated .data .json output (the format will change again in a next release)
	* Updated tests

Mathieu Giraud's avatar
Mathieu Giraud committed
172
2014-07-28  The Vidjil Team
173 174
	* Better heuristic, segment more reads (core/affectanalyser.h, core/segment.cpp)
	  This improved heuristic was designed to implement a multi-germline analysis in a next release.
175
	* Improved computation of the heuristic affectation. Halves the time of -c windows (core/kmerstore.h)
176 177 178 179 180
	* New command '-c germlines', discovering germlines (vidjil.cpp)
	* New unit tests, updated some tests
	* Updated .json output (experimental distance graph)
	* Bugs closed

181
2014-03-27  The Vidjil Team
182
	* Better default seed selection, depending on the germline, segments more reads (vidjil.cpp)
183
	* Better selection of representative read (core/representative.cpp)
184 185
	* New option to output all clones (-A), for testing purposes
	* Updated debug option (-u) to display k-mer affection (core/windowExtractor.cpp)
186
	* New unit tests, updated some tests
187
	* Improved management of dependencies (Makefile)
188
	* Improved documentation and comments on main stdout
189

Mathieu Giraud's avatar
Mathieu Giraud committed
190 191 192 193 194 195 196 197
2014-02-20  The Vidjil Team
	* Refactored main vidjil.cpp (core/windows.cpp, core/windowExtractor.cpp)
	* Removed unused html output
	* Better json output (core/json.cpp)
	* Updated main stdout, with representative sequence for each clone
	* Updated parameters for FineSegmenter (delta_max) and dynprog (substition cost)
	* Bugs closed

Mikaël Salson's avatar
Mikaël Salson committed
198 199 200 201 202 203 204 205 206 207
2013-10-07  The Vidjil Team
	* Better heuristic, segments more reads (core/segment.cpp)
        * Better and faster selection of representative read (vidjil.cpp, core/read_chooser.cpp)
        * Better display of reason of non-segmenting reads
        * New normalization against a standard (-Z) (core/labels.cpp)
        * New experimental lazy_msa multiple aligner
        * New .json output
        * New unit tests
        * Bugs closed

Mathieu Giraud's avatar
Mathieu Giraud committed
208 209 210 211 212 213 214
2013-07-03  The Vidjil Team
	* New selection of representative read (core/read_chooser.cpp)
	* Faster spaced seed computation (core/tools.cpp)
	* New unit tests
	* Bugs closed

2013-04-18  The Vidjil Team
Mikaël Salson's avatar
Mikaël Salson committed
215 216 217
	* First public release