CHANGELOG 9.54 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 5
2015-10-05  The Vidjil Team
	* Better FineSegmenter V(D)J assignation, especially when V/D/J segments are close (core/segment.cpp)
6
	* 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
7
	* Refactored tests for V(D)J assignation, allowing flexible patterns, new documentation (doc/should-vdj.org)
8 9 10
	* 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
11
2015-07-21  The Vidjil Team
12 13 14 15 16 17
        * 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
18
        * Updated build process, now requiring a C++11 compiler
19 20 21
        * 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
22
2015-06-05  The Vidjil Team
23 24 25 26 27 28
        * 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
29
        * Streamlined again unsegmentation causes and removed delta_{min,max} for the heuristic (core/segment.cpp)
30 31
        * Refactored stats computation (core/read_storage.cpp)
        * Updated build process
Mathieu Giraud's avatar
Mathieu Giraud committed
32 33 34
          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)
35 36
        * New and updated unit and functional tests, and faster functional tests

Mathieu Giraud's avatar
Mathieu Giraud committed
37
2015-05-08  The Vidjil Team
38 39 40
        * 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)
41
        * New experimental trim option (-t), considering only the relevant ends of the germline genes (core/kmerstore.h)
42 43 44 45 46 47 48
        * 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
49
2015-04-09  The Vidjil Team
50
        * New experimental e-value threshold (-e) (core/segment.cpp)
Mathieu Giraud's avatar
Mathieu Giraud committed
51
        * New experimental unexpected recombination analysis (-2) (core/segment.cpp)
52 53 54 55 56 57 58 59 60 61 62
        * 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
63
2015-03-04  The Vidjil Team
64 65 66 67 68
	* 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
69
	* New statistics on the number of clones (core/germline.cpp)
70
	* 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
71
	* Better debug option -K (.affect), especially in the case of multi-germline analysis
72 73 74
	* Refactored dynamic programming computations (core/dynprog.cpp), experimental affine gaps
	* Removed unused code parts as well as some files
	* Streamlined flag processing in Makefiles
75
	* New mechanism for some functional tests (make shouldvdj)
76
	* New experimental tests from generated recombinations (make shouldvdj_generated)
77
	* New and updated unit and functional tests
78 79 80 81 82 83 84

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
85
2014-12-22  The Vidjil Team
86 87 88 89 90
	* 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
91
2014-11-28  The Vidjil Team
92 93
	* 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
94
	* Streamlined input. Option -d is removed, and a germline is required (-V/(-D)/-J, or -G, or -g)
95 96 97 98 99
	* 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
100
2014-10-22  The Vidjil Team
101
	* Streamlined filtering options (-r/-y/-z), better documented (doc/algo.org)
Mathieu Giraud's avatar
Mathieu Giraud committed
102 103
	* 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)
104
	* New experimental multi-germline analysis (-g). This will be improved and documented in a next release.
Mathieu Giraud's avatar
Mathieu Giraud committed
105
	* Faster FineSegmenter with a better memory allocation (core/dynprog.cpp)
106 107 108
	* 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
109
	* New and updated unit and functional tests
110 111
	* Bugs closed

Mathieu Giraud's avatar
Mathieu Giraud committed
112
2014-09-23  The Vidjil Team
113 114 115 116 117
	* 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
118
2014-07-28  The Vidjil Team
119 120
	* 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.
121
	* Improved computation of the heuristic affectation. Halves the time of -c windows (core/kmerstore.h)
122 123 124 125 126
	* New command '-c germlines', discovering germlines (vidjil.cpp)
	* New unit tests, updated some tests
	* Updated .json output (experimental distance graph)
	* Bugs closed

127
2014-03-27  The Vidjil Team
128
	* Better default seed selection, depending on the germline, segments more reads (vidjil.cpp)
129
	* Better selection of representative read (core/representative.cpp)
130 131
	* New option to output all clones (-A), for testing purposes
	* Updated debug option (-u) to display k-mer affection (core/windowExtractor.cpp)
132
	* New unit tests, updated some tests
133
	* Improved management of dependencies (Makefile)
134
	* Improved documentation and comments on main stdout
135

Mathieu Giraud's avatar
Mathieu Giraud committed
136 137 138 139 140 141 142 143
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
144 145 146 147 148 149 150 151 152 153
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
154 155 156 157 158 159 160
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
161 162 163
	* First public release