vidjil.cpp 42.4 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1
/*
2
3
4
5
6
7
8
  This file is part of Vidjil <http://www.vidjil.org>
  Copyright (C) 2011, 2012, 2013, 2014, 2015 by Bonsai bioinformatics 
  at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille
  Contributors: 
      Mathieu Giraud <mathieu.giraud@vidjil.org>
      Mikaël Salson <mikael.salson@vidjil.org>
      Marc Duez <marc.duez@vidjil.org>
Mikaël Salson's avatar
Mikaël Salson committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

  "Vidjil" is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  "Vidjil" is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with "Vidjil". If not, see <http://www.gnu.org/licenses/>
*/

Mathieu Giraud's avatar
Mathieu Giraud committed
24
//$$ #include
Mikaël Salson's avatar
Mikaël Salson committed
25
26
27
28
29
30
31
32
33
34
35
36
37
38

#include<algorithm>
#include<utility>
#include <cstdlib>
#include <fstream>
#include <iostream>
#include <string>
#include <cstring>
#include <time.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include "core/tools.h"
WebTogz's avatar
WebTogz committed
39
#include "core/json.h"
40
#include "core/germline.h"
Mikaël Salson's avatar
Mikaël Salson committed
41
42
43
#include "core/kmerstore.h"
#include "core/fasta.h"
#include "core/segment.h"
Mathieu Giraud's avatar
Mathieu Giraud committed
44
#include "core/windows.h"
Mikaël Salson's avatar
Mikaël Salson committed
45
46
47
48
49
50
51
#include "core/cluster-junctions.h"
#include "core/dynprog.h"
#include "core/read_score.h"
#include "core/read_chooser.h"
#include "core/compare-all.h"
#include "core/mkdir.h"
#include "core/labels.h"
Mikaël Salson's avatar
Mikaël Salson committed
52
#include "core/list_utils.h"
Mathieu Giraud's avatar
Mathieu Giraud committed
53
#include "core/windowExtractor.h"
Mikaël Salson's avatar
Mikaël Salson committed
54
55
56
57
58
59
60
61

#include "vidjil.h"

// RELEASE_TAG may be defined in the "release.h" file.
// If RELEASE_TAG is undefined, the version will be the git hash.
// #define RELEASE_TAG  "2013.04"
#include "release.h"

62
63
64
// GIT_VERSION should be defined in "git-version.h", created by "create-git-version-h.sh", to be used outside of releases
#include "git-version.h"

65
#define VIDJIL_JSON_VERSION "2014.10"
Mikaël Salson's avatar
Mikaël Salson committed
66

Mathieu Giraud's avatar
Mathieu Giraud committed
67
68
//$$ #define (mainly default options)

69
#define DEFAULT_MULTIGERMLINE "germline"
Mikaël Salson's avatar
Mikaël Salson committed
70

Mathieu Giraud's avatar
Mathieu Giraud committed
71
#define DEFAULT_READS  "./data/Stanford_S22.fasta"
72
#define DEFAULT_MIN_READS_CLONE 5
73
#define DEFAULT_MAX_REPRESENTATIVES 100
74
75
#define DEFAULT_MAX_CLONES 20
#define DEFAULT_RATIO_READS_CLONE 0.0
76
#define NO_LIMIT "all"
Mikaël Salson's avatar
Mikaël Salson committed
77

Mathieu Giraud's avatar
Mathieu Giraud committed
78
#define COMMAND_WINDOWS "windows"
79
#define COMMAND_CLONES "clones"
Mikaël Salson's avatar
Mikaël Salson committed
80
#define COMMAND_SEGMENT "segment"
81
#define COMMAND_GERMLINES "germlines"
Mikaël Salson's avatar
Mikaël Salson committed
82
 
83
enum { CMD_WINDOWS, CMD_CLONES, CMD_SEGMENT, CMD_GERMLINES } ;
Mikaël Salson's avatar
Mikaël Salson committed
84

85
86
87
#define DEFAULT_OUT_DIR "./out/" 

// Fixed filenames/suffixes
88
#define CLONES_FILENAME ".vdj.fa"
Mikaël Salson's avatar
Mikaël Salson committed
89
#define CLONE_FILENAME "clone.fa-"
90
91
92
93
94
95
#define WINDOWS_FILENAME ".windows.fa"
#define SEGMENTED_FILENAME ".segmented.vdj.fa"
#define UNSEGMENTED_FILENAME ".unsegmented.fa"
#define EDGES_FILENAME ".edges"
#define COMP_FILENAME "comp.vidjil"
#define JSON_SUFFIX ".vidjil"
Mikaël Salson's avatar
Mikaël Salson committed
96
97
98

// "tests/data/leukemia.fa" 

99
#define DEFAULT_K      0
Mikaël Salson's avatar
Mikaël Salson committed
100
#define DEFAULT_W      40
Mikaël Salson's avatar
Mikaël Salson committed
101
#define DEFAULT_W_D    60
102
#define DEFAULT_SEED   ""
Mikaël Salson's avatar
Mikaël Salson committed
103
104

#define DEFAULT_DELTA_MIN  -10
Mathieu Giraud's avatar
Mathieu Giraud committed
105
#define DEFAULT_DELTA_MAX   20
Mikaël Salson's avatar
Mikaël Salson committed
106
107

#define DEFAULT_DELTA_MIN_D  0
108
#define DEFAULT_DELTA_MAX_D  80
Mikaël Salson's avatar
Mikaël Salson committed
109

Mikaël Salson's avatar
Mikaël Salson committed
110
#define DEFAULT_MAX_AUDITIONED 2000
Mathieu Giraud's avatar
Mathieu Giraud committed
111
112
#define DEFAULT_RATIO_REPRESENTATIVE 0.5

Mikaël Salson's avatar
Mikaël Salson committed
113
114
115
116
117
118
#define DEFAULT_EPSILON  0
#define DEFAULT_MINPTS   10

#define DEFAULT_CLUSTER_COST  Cluster
#define DEFAULT_SEGMENT_COST   VDJ

119
120
121
// error
#define ERROR_STRING "[error] "

122
// warn
123
#define WARN_MAX_CLONES 100
124
#define WARN_PERCENT_SEGMENTED 40
125

Mikaël Salson's avatar
Mikaël Salson committed
126
127
128
// display
#define WIDTH_NB_READS 7
#define WIDTH_NB_CLONES 3
129

Mikaël Salson's avatar
Mikaël Salson committed
130
131
132

using namespace std ;

Mathieu Giraud's avatar
Mathieu Giraud committed
133
//$$ options: usage
Mikaël Salson's avatar
Mikaël Salson committed
134

Mathieu Giraud's avatar
Mathieu Giraud committed
135
extern char *optarg;
Mikaël Salson's avatar
Mikaël Salson committed
136
137
138
139
140

extern int optind, optopt, opterr;

void usage(char *progname)
{
141
  cerr << "Usage: " << progname << " [options] <reads.fa/.fq/.gz>" << endl << endl;
Mikaël Salson's avatar
Mikaël Salson committed
142
143

  cerr << "Command selection" << endl
144
145
       << "  -c <command> \t" << COMMAND_WINDOWS << "  \t window extracting" << endl 
       << "  \t\t" << COMMAND_CLONES  << "  \t clone gathering (default)" << endl 
146
       << "  \t\t" << COMMAND_SEGMENT   << "  \t V(D)J segmentation (not recommended)" << endl
147
       << "  \t\t" << COMMAND_GERMLINES << "  \t discover all germlines" << endl
Mikaël Salson's avatar
Mikaël Salson committed
148
149
       << endl       

150
       << "Germline databases (one -V/(-D)/-J, or -G, or -g option must be given for all commands except -c " << COMMAND_GERMLINES << ")" << endl
Mikaël Salson's avatar
Mikaël Salson committed
151
       << "  -V <file>     V germline multi-fasta file" << endl
152
       << "  -D <file>     D germline multi-fasta file (and resets -m, -M and -w options), will segment into V(D)J components" << endl
Mikaël Salson's avatar
Mikaël Salson committed
153
       << "  -J <file>     J germline multi-fasta file" << endl
154
       << "  -G <prefix>   prefix for V (D) and J repertoires (shortcut for -V <prefix>V.fa -D <prefix>D.fa -J <prefix>J.fa) (basename gives germline code)" << endl
155
       << "  -g <path>     multiple germlines (in the path <path>, takes TRA, TRB, TRG, TRD, IGH and IGL and sets window prediction parameters)" << endl
156
       << "  -i            multiple germlines, also incomplete rearrangements (experimental, must be used with -g)" << endl
157
       << "  -I            ignore k-mers common to different germline systems (experimental, must be used with -g, do not use)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
158
159
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
160
       << "Window prediction" << endl
Mikaël Salson's avatar
Mikaël Salson committed
161
#ifndef NO_SPACED_SEEDS
162
       << "  (use either -s or -k option, but not both)" << endl
163
       << "  (all these options, except -w, are overriden when using -g)" << endl
164
165
       << "  -s <string>   spaced seed used for the V/J affectation" << endl
       << "                (default: #####-#####, ######-######, #######-#######, depends on germline)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
166
#endif
167
       << "  -k <int>      k-mer size used for the V/J affectation (default: 10, 12, 13, depends on germline)" << endl
168
169
170
#ifndef NO_SPACED_SEEDS
       << "                (using -k option is equivalent to set with -s a contiguous seed with only '#' characters)" << endl
#endif
171
172
173
       << "  -m <int>      minimal admissible delta between last V and first J k-mer (default: " << DEFAULT_DELTA_MIN << ") (default with -D: " << DEFAULT_DELTA_MIN_D << ")" << endl
       << "  -M <int>      maximal admissible delta between last V and first J k-mer (default: " << DEFAULT_DELTA_MAX << ") (default with -D: " << DEFAULT_DELTA_MAX_D << ")" << endl
       << "  -w <int>      w-mer size used for the length of the extracted window (default: " << DEFAULT_W << ") (default with -D: " << DEFAULT_W_D << ")" << endl
Mikaël Salson's avatar
Mikaël Salson committed
174
175
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
176
       << "Window annotations" << endl
177
       << "  -l <file>     labels for some windows -- these windows will be kept even if -r/-% thresholds are not reached" << endl
Mikaël Salson's avatar
Mikaël Salson committed
178
179
       << endl

180
       << "Limits to report a clone (or a window)" << endl
181
182
       << "  -r <nb>       minimal number of reads supporting a clone (default: " << DEFAULT_MIN_READS_CLONE << ")" << endl
       << "  -% <ratio>    minimal percentage of reads supporting a clone (default: " << DEFAULT_RATIO_READS_CLONE << ")" << endl
183
184
       << endl

185
       << "Limits to further analyze some clones" << endl
186
       << "  -y <nb>       maximal number of clones computed with a representative ('" << NO_LIMIT << "': no limit) (default: " << DEFAULT_MAX_REPRESENTATIVES << ")" << endl
187
       << "  -z <nb>       maximal number of clones to be segmented ('" << NO_LIMIT << "': no limit, do not use) (default: " << DEFAULT_MAX_CLONES << ")" << endl
188
       << "  -A            reports and segments all clones (-r 0 -% 0 -y " << NO_LIMIT << " -z " << NO_LIMIT << "), to be used only on very small datasets" << endl
Mikaël Salson's avatar
Mikaël Salson committed
189
190
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
191
       << "Fine segmentation options (second pass, see warning in doc/algo.org)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
192
193
194
       << "  -f <string>   use custom Cost for fine segmenter : format \"match, subst, indels, homo, del_end\" (default "<<VDJ<<" )"<< endl
       << endl

195
196
197
198
199
200
201
202
203
       << "Additional clustering" << endl
       << "  -e <file>     manual clustering -- a file used to force some specific edges" << endl
       << "  -n <int>      maximum distance between neighbors for automatic clustering (default " << DEFAULT_EPSILON << "). No automatic clusterisation if =0." << endl
       << "  -N <int>      minimum required neighbors for automatic clustering (default " << DEFAULT_MINPTS << ")" << endl
       << "  -S            generate and save comparative matrix for clustering" << endl
       << "  -L            load comparative matrix for clustering" << endl
       << "  -C <string>   use custom Cost for automatic clustering : format \"match, subst, indels, homo, del_end\" (default "<<Cluster<<" )"<< endl
       << endl

204
       << "Debug" << endl
205
206
       << "  -U            output segmented (in " << SEGMENTED_FILENAME << " file) sequences" << endl
       << "  -u            output unsegmented (in " << UNSEGMENTED_FILENAME << " file) sequences" << endl
207
       << "                and display detailed k-mer affectation both on segmented and on unsegmented sequences" << endl
Mikaël Salson's avatar
Mikaël Salson committed
208
       << "Output" << endl
209
       << "  -o <dir>      output directory (default: " << DEFAULT_OUT_DIR << ")" <<  endl
210
       << "  -b <string>   output basename (by default basename of the input file)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
211
    
212
       << "  -a            output all sequences by cluster (" << CLONE_FILENAME << "*), to be used only on small datasets" << endl
Mikaël Salson's avatar
Mikaël Salson committed
213
214
215
       << "  -v            verbose mode" << endl
       << endl        

216
217
218
       << "The full help is available in the doc/algo.org file."
       << endl

Mikaël Salson's avatar
Mikaël Salson committed
219
       << endl 
Mathieu Giraud's avatar
Mathieu Giraud committed
220
       << "Examples (see doc/algo.org)" << endl
Mathieu Giraud's avatar
Mathieu Giraud committed
221
222
       << "  " << progname << " -c clones   -G germline/IGH  -r 5          data/Stanford_S22.fasta" << endl
       << "  " << progname << " -c segment  -G germline/IGH                data/Stanford_S22.fasta   # (only for testing)" << endl
223
       << "  " << progname << " -c germlines                               data/Stanford_S22.fasta" << endl
Mikaël Salson's avatar
Mikaël Salson committed
224
225
226
227
228
229
    ;
  exit(1);
}

int main (int argc, char **argv)
{
230
  cout << "# Vidjil -- V(D)J recombinations analysis <http://www.vidjil.org/>" << endl
231
232
       << "# Copyright (C) 2011, 2012, 2013, 2014, 2015 by the Vidjil team" << endl
       << "# Bonsai bioinformatics at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille" << endl 
Mathieu Giraud's avatar
Mathieu Giraud committed
233
234
235
236
237
       << endl
       << "# Vidjil is free software, and you are welcome to redistribute it" << endl
       << "# under certain conditions -- see http://git.vidjil.org/blob/master/doc/LICENSE" << endl
       << "# No lymphocyte was harmed in the making of this software," << endl
       << "# however this software is for research use only and comes with no warranty." << endl
238
239
       << endl
       << "# Please cite http://biomedcentral.com/1471-2164/15/409 if you use Vidjil." 
Mikaël Salson's avatar
Mikaël Salson committed
240
241
       << endl ;

Mathieu Giraud's avatar
Mathieu Giraud committed
242
243
  //$$ options: defaults

244
  string germline_system = "" ;
245
246
247
248
249
  
  list <string> f_reps_V ;
  list <string> f_reps_D ;
  list <string> f_reps_J ;

Mikaël Salson's avatar
Mikaël Salson committed
250
251
  string f_reads = DEFAULT_READS ;
  string seed = DEFAULT_SEED ;
252
  string f_basename = "";
Mikaël Salson's avatar
Mikaël Salson committed
253

254
  string out_dir = DEFAULT_OUT_DIR;
Mikaël Salson's avatar
Mikaël Salson committed
255
256
257
258
  
  string comp_filename = COMP_FILENAME;

  int k = DEFAULT_K ;
Mikaël Salson's avatar
Mikaël Salson committed
259
260
261
  int w = 0 ;
  int default_w = DEFAULT_W ;

Mikaël Salson's avatar
Mikaël Salson committed
262
263
264
265
266
267
268
269
270
271
  int epsilon = DEFAULT_EPSILON ;
  int minPts = DEFAULT_MINPTS ;
  Cost cluster_cost = DEFAULT_CLUSTER_COST ;
  Cost segment_cost = DEFAULT_SEGMENT_COST ;
  
  
  int save_comp = 0;
  int load_comp = 0;
  
  int verbose = 0 ;
272
  int command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
273

274
  int max_representatives = DEFAULT_MAX_REPRESENTATIVES ;
275
276
277
  int max_clones = DEFAULT_MAX_CLONES ;
  int min_reads_clone = DEFAULT_MIN_READS_CLONE ;
  float ratio_reads_clone = DEFAULT_RATIO_READS_CLONE;
Mikaël Salson's avatar
Mikaël Salson committed
278
279
  // int average_deletion = 4;     // Average number of deletion in V or J

Mathieu Giraud's avatar
Mathieu Giraud committed
280
  float ratio_representative = DEFAULT_RATIO_REPRESENTATIVE;
Mikaël Salson's avatar
Mikaël Salson committed
281
  unsigned int max_auditionned = DEFAULT_MAX_AUDITIONED;
Mathieu Giraud's avatar
Mathieu Giraud committed
282

Mikaël Salson's avatar
Mikaël Salson committed
283
284
285
286
287
  // Admissible delta between left and right segmentation points
  int delta_min = DEFAULT_DELTA_MIN ; // Kmer+Fine
  int delta_max = DEFAULT_DELTA_MAX ; // Fine

  bool output_sequences_by_cluster = false;
288
  bool output_segmented = false;
Mathieu Giraud's avatar
Mathieu Giraud committed
289
  bool output_unsegmented = false;
290
  bool multi_germline = false;
291
  bool multi_germline_incomplete = false;
292
  bool multi_germline_mark = false;
293
  string multi_germline_file = DEFAULT_MULTIGERMLINE;
Mikaël Salson's avatar
Mikaël Salson committed
294
295
296

  string forced_edges = "" ;

Mathieu Giraud's avatar
Mathieu Giraud committed
297
  string windows_labels_file = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
298
299
300

  char c ;

301
302
  int options_s_k = 0 ;

WebTogz's avatar
WebTogz committed
303
304
305
  //JsonArray which contains the Levenshtein distances
  JsonArray jsonLevenshtein;

Mathieu Giraud's avatar
Mathieu Giraud committed
306
307
  //$$ options: getopt

308
  while ((c = getopt(argc, argv, "AhaiIg:G:V:D:J:k:r:vw:e:C:f:l:c:m:M:N:s:b:Sn:o:L%:y:z:uU")) != EOF)
Mikaël Salson's avatar
Mikaël Salson committed
309
310
311
312
313

    switch (c)
      {
      case 'h':
        usage(argv[0]);
314

Mikaël Salson's avatar
Mikaël Salson committed
315
      case 'c':
316
317
        if (!strcmp(COMMAND_CLONES,optarg))
          command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
318
319
        else if (!strcmp(COMMAND_SEGMENT,optarg))
          command = CMD_SEGMENT;
Mathieu Giraud's avatar
Mathieu Giraud committed
320
321
        else if (!strcmp(COMMAND_WINDOWS,optarg))
          command = CMD_WINDOWS;
322
323
        else if (!strcmp(COMMAND_GERMLINES,optarg))
          command = CMD_GERMLINES;
Mikaël Salson's avatar
Mikaël Salson committed
324
325
326
327
328
        else {
          cerr << "Unknwown command " << optarg << endl;
	  usage(argv[0]);
        }
        break;
329

Mikaël Salson's avatar
Mikaël Salson committed
330
331
332
333

      // Germline

      case 'V':
334
	f_reps_V.push_back(optarg);
335
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
336
337
338
	break;

      case 'D':
339
	f_reps_D.push_back(optarg);
340
341
342
	delta_min = DEFAULT_DELTA_MIN_D ;
	delta_max = DEFAULT_DELTA_MAX_D ;
	default_w = DEFAULT_W_D ;
Mikaël Salson's avatar
Mikaël Salson committed
343
344
345
	break;
        
      case 'J':
346
	f_reps_J.push_back(optarg);
347
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
348
349
	break;

350
      case 'g':
351
352
	multi_germline = true;
	multi_germline_file = string(optarg);
353
	germline_system = "multi" ;
354
	break;
355
356
357
358

      case 'i':
	multi_germline_incomplete = true;
	break;
359
360
361
362

      case 'I':
        multi_germline_mark = true;
	break;
363
        
Mikaël Salson's avatar
Mikaël Salson committed
364
      case 'G':
Mikaël Salson's avatar
Mikaël Salson committed
365
	germline_system = string(optarg);
366
	f_reps_V.push_back((germline_system + "V.fa").c_str()) ;
367
368
369
370
371
        // Takes D only if it exists
        {
          struct stat buffer; 
          string putative_f_rep_D = germline_system + "D.fa" ;
          if (stat(putative_f_rep_D.c_str(), &buffer) == 0)
372
373
374
375
376
377
            {
              f_reps_D.push_back(putative_f_rep_D.c_str()) ;
              delta_min = DEFAULT_DELTA_MIN_D ;
              delta_max = DEFAULT_DELTA_MAX_D ;
              default_w = DEFAULT_W_D ;
            }
378
        }
379
	f_reps_J.push_back((germline_system + "J.fa").c_str()) ;
380
	germline_system = extract_basename(germline_system);
381

Mikaël Salson's avatar
Mikaël Salson committed
382
383
384
385
	break;

      // Algorithm

386
387
388
389
390
391
392
393
394
395
      case 's':
#ifndef NO_SPACED_SEEDS
	seed = string(optarg);
	k = seed_weight(seed);
	options_s_k++ ;
#else
        cerr << "To enable the option -s, please compile without NO_SPACED_SEEDS" << endl;
#endif
        break;

Mikaël Salson's avatar
Mikaël Salson committed
396
397
398
      case 'k':
	k = atoi(optarg);
	seed = seed_contiguous(k);
399
	options_s_k++ ;
Mikaël Salson's avatar
Mikaël Salson committed
400
401
402
403
404
405
406
407
408
409
410
411
412
413
        break;

      case 'w':
	w = atoi(optarg);
        break;

      case 'm':
	delta_min = atoi(optarg);
        break;

      case 'M':
	delta_max = atoi(optarg);
        break;

414
415
      // Output 

Mikaël Salson's avatar
Mikaël Salson committed
416
417
418
419
      case 'o':
        out_dir = optarg ;
        break;

420
421
      case 'b':
        f_basename = optarg;
Mikaël Salson's avatar
Mikaël Salson committed
422
423
        break;

424
425
426
427
428
429
430
431
      case 'a':
	output_sequences_by_cluster = true;
	break;

      case 'v':
	verbose += 1 ;
	break;

432
433
      // Limits

Mikaël Salson's avatar
Mikaël Salson committed
434
435
436
437
      case '%':
	ratio_reads_clone = atof(optarg);
	break;

438
      case 'r':
Mikaël Salson's avatar
Mikaël Salson committed
439
440
441
	min_reads_clone = atoi(optarg);
        break;

442
      case 'y':
443
444
445
446
447
	if (!strcmp(NO_LIMIT, optarg))
	  {
	    max_representatives = -1;
	    break;
	  }
448
449
450
	max_representatives = atoi(optarg);
        break;

Mikaël Salson's avatar
Mikaël Salson committed
451
      case 'z':
452
453
454
455
456
	if (!strcmp(NO_LIMIT, optarg))
	  {
	    max_clones = -1;
	    break;
	  }
Mikaël Salson's avatar
Mikaël Salson committed
457
458
	max_clones = atoi(optarg);
        break;
459
460
461

      case 'A': // --all
	ratio_reads_clone = 0 ;
462
463
464
	min_reads_clone = 1 ;
	max_representatives = -1 ;
	max_clones = -1 ;
465
466
	break ;

467
468
469
470
      case 'l':
	windows_labels_file = optarg; 
	break;

471
      // Clustering
472
473
474
475

      case 'e':
	forced_edges = optarg;
	break;
Mikaël Salson's avatar
Mikaël Salson committed
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
	
      case 'n':
	epsilon = atoi(optarg);
        break;

      case 'N':
	minPts = atoi(optarg);
        break;
	
      case 'S':
	save_comp=1;
        break;

      case 'L':
	load_comp=1;
        break;
	
      case 'C':
	cluster_cost=strToCost(optarg, Cluster);
        break;
	
497
498
      // Fine segmentation

499
      case 'f':
Mikaël Salson's avatar
Mikaël Salson committed
500
501
	segment_cost=strToCost(optarg, VDJ);
        break;
Mathieu Giraud's avatar
Mathieu Giraud committed
502
503
504
505

      case 'u':
        output_unsegmented = true;
        break;
506
507
508
      case 'U':
        output_segmented = true;
        break;
Mikaël Salson's avatar
Mikaël Salson committed
509
510
      }

511
512
513

  //$$ options: post-processing+display

514
515
516
517
518
519
520

  if (!germline_system.size() && (command != CMD_GERMLINES))
    {
      cout << ERROR_STRING << "At least one germline must be given with -V/(-D)/-J, or -G, or -g." << endl ;
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
521
522
523
524
525
  // If there was no -w option, then w is either DEFAULT_W or DEFAULT_W_D
  if (w == 0)
    w = default_w ;

  
526
527
  if (options_s_k > 1)
    {
528
      cout << ERROR_STRING << "Use at most one -s or -k option." << endl ;
529
530
531
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
532
533
  string out_seqdir = out_dir + "/seq/" ;

Mikaël Salson's avatar
Mikaël Salson committed
534
535
536
537
538
539
540
541
542
543
544
545
546
  if (verbose)
    cout << "# verbose " << verbose << endl ;

  if (optind == argc)
    {
      cout << "# using default sequence file: " << f_reads << endl ;
    }
  else if (optind+1 == argc)
    {
      f_reads = argv[optind] ; 
    }
  else
    {
547
      cout << ERROR_STRING << "Wrong number of arguments." << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
548
549
      exit(1);
    }
Mathieu Giraud's avatar
Mathieu Giraud committed
550

551
  size_t min_cover_representative = (size_t) (min_reads_clone < (int) max_auditionned ? min_reads_clone : max_auditionned) ;
552

553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  // Default seeds

#ifndef NO_SPACED_SEEDS
  if (k == DEFAULT_K)
    {
      if (germline_system.find("TRA") != string::npos)
	seed = "#######-######" ;

      else if ((germline_system.find("TRB") != string::npos)
	       || (germline_system.find("IGH") != string::npos))
	seed = "######-######" ; 
      else // TRD, TRG, IGK, IGL
	seed = "#####-#####" ; 

      k = seed_weight(seed);
    }
#else
  {
571
    cout << ERROR_STRING << "Vidjil was compiled with NO_SPACED_SEEDS: please provide a -k option." << endl;
572
573
574
575
576
    exit(1) ;
  }
#endif
	  

Mathieu Giraud's avatar
Mathieu Giraud committed
577
578
579
580
#ifndef NO_SPACED_SEEDS
  // Check seed buffer  
  if (seed.size() >= MAX_SEED_SIZE)
    {
581
      cout << ERROR_STRING << "Seed size is too large (MAX_SEED_SIZE)." << endl ;
Mathieu Giraud's avatar
Mathieu Giraud committed
582
583
584
585
      exit(1);
    }
#endif

586
587
588

  if (w < seed_weight(seed))
    {
589
      cout << ERROR_STRING << "Too small -w. The window size should be at least equal to the seed size (" << seed_weight(seed) << ")." << endl;
590
591
592
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
593
594
595
596
  // Check that out_dir is an existing directory or creates it
  const char *out_cstr = out_dir.c_str();

  if (mkpath(out_cstr, 0755) == -1) {
597
    cout << ERROR_STRING << "Directory creation: " << out_dir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
598
599
600
    exit(2);
  }

Mikaël Salson's avatar
Mikaël Salson committed
601
602
  const char *outseq_cstr = out_seqdir.c_str();
  if (mkpath(outseq_cstr, 0755) == -1) {
603
    cout << ERROR_STRING << "Directory creation: " << out_seqdir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
604
605
606
    exit(2);
  }

607
608
609
610
611
  // Compute basename if not given as an option
  if (f_basename == "") {
    f_basename = extract_basename(f_reads);
  }

Mikaël Salson's avatar
Mikaël Salson committed
612
613
614
  out_dir += "/" ;

  /// Load labels ;
Mathieu Giraud's avatar
Mathieu Giraud committed
615
  map <string, string> windows_labels = load_map(windows_labels_file);
Mikaël Salson's avatar
Mikaël Salson committed
616
617

  switch(command) {
Mathieu Giraud's avatar
Mathieu Giraud committed
618
  case CMD_WINDOWS: cout << "Extracting windows" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
619
    break;
620
  case CMD_CLONES: cout << "Analysing clones" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
621
622
623
    break;
  case CMD_SEGMENT: cout << "Segmenting V(D)J" << endl;
    break;
624
625
  case CMD_GERMLINES: cout << "Discovering germlines" << endl;
    break;
Mikaël Salson's avatar
Mikaël Salson committed
626
627
  }

Mathieu Giraud's avatar
Mathieu Giraud committed
628
  cout << "Command line: ";
Mikaël Salson's avatar
Mikaël Salson committed
629
  for (int i=0; i < argc; i++) {
Mathieu Giraud's avatar
Mathieu Giraud committed
630
    cout << argv[i] << " ";
Mikaël Salson's avatar
Mikaël Salson committed
631
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
632
  cout << endl;
Mikaël Salson's avatar
Mikaël Salson committed
633
634
635
636
637
638
639
640
641
642
643
644

  //////////////////////////////////
  // Display time and date
  time_t rawtime;
  struct tm *timeinfo;
  char time_buffer[80];

  time (&rawtime );
  timeinfo = localtime (&rawtime);

  strftime (time_buffer, 80,"%F %T", timeinfo);

Mathieu Giraud's avatar
Mathieu Giraud committed
645
  cout << "# " << time_buffer << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
646
647
648
649
650


  //////////////////////////////////
  // Display version information or git log

651
  string soft_version = "vidjil ";
Mikaël Salson's avatar
Mikaël Salson committed
652
#ifdef RELEASE_TAG
Mathieu Giraud's avatar
Mathieu Giraud committed
653
  cout << "# version: vidjil " << RELEASE_TAG << endl ;
654
  soft_version.append(RELEASE_TAG);
Mikaël Salson's avatar
Mikaël Salson committed
655
#else
656
  cout << "# development version" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
657
658
#endif

659
660
#ifdef GIT_VERSION
  cout << "# git: " << GIT_VERSION << endl ;
661
  soft_version.append("dev ");
662
  soft_version.append(GIT_VERSION);
663
#endif
664

665

666
667
  //////////////////////////////////
  // Warning for non-optimal use
668

669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
  if (max_clones == -1 || max_clones > WARN_MAX_CLONES)
    {
      cout << endl
	   << "* WARNING: vidjil was run with '-A' option or with a large '-z' option" << endl ;
    }
  
  if (command == CMD_SEGMENT)
    {
      cout << endl
	   << "* WARNING: vidjil was run with '-c segment' option" << endl ;
    }
  
  if (max_clones == -1 || max_clones > WARN_MAX_CLONES || command == CMD_SEGMENT)
    {
      cout << "* Vidjil purpose is to extract very quickly windows overlapping the CDR3" << endl
	   << "* and to gather reads into clones (-c clones), and not to provide an accurate V(D)J segmentation." << endl
	   << "* The following segmentations are slow to compute and are provided only for convenience." << endl
	   << "* They should be checked with other softwares such as IgBlast, iHHMune-align or IMGT/V-QUEST." << endl 
	   << "* More information is provided in the 'doc/algo.org' file." << endl 
	   << endl ;
    }
690

691
692
693
  /////////////////////////////////////////
  //            LOAD GERMLINES           //
  /////////////////////////////////////////
694

695
  MultiGermline *multigermline = new MultiGermline();
696

697
    {
698
      cout << "Load germlines and build Kmer indexes" << endl ;
699
700
701
702
    
      if (multi_germline)
	{
	  multigermline->build_default_set(multi_germline_file);
703
704
          if (multi_germline_incomplete)
            multigermline->build_incomplete_set(multi_germline_file);
705
706
	}
      else if (command == CMD_GERMLINES)
707
	{
708
709
	  multigermline->load_standard_set(multi_germline_file);
	  multigermline->build_with_one_index(seed);
710
	}
711
712
713
714
715
      else
	{
	  // Custom germline
	  Germline *germline;
	  germline = new Germline(germline_system, 'X',
716
717
718
                                  f_reps_V, f_reps_D, f_reps_J, 
                                  delta_min, delta_max);

719
720
721

	  if (command == CMD_WINDOWS || command == CMD_CLONES)
	    germline->new_index(seed);
722

723
724
725
	  multigermline->insert(germline);
	}
    }
726

727
    cout << endl ;
728

729
730
731
    if (multi_germline_mark)
      multigermline->mark_cross_germlines_as_ambiguous();
    
732
733
734
735
    cout << "Germlines loaded" << endl ;
    cout << *multigermline ;
    cout << endl ;
    
736
737
738
739
740
741
742
  //////////////////////////////////
  //$$ Read sequence files
 
  OnlineFasta *reads;

  try {
    reads = new OnlineFasta(f_reads, 1, " ");
743
  } catch (const invalid_argument e) {
744
    cout << ERROR_STRING << "Vidjil cannot open reads file " << f_reads << ": " << e.what() << endl;
745
746
747
748
749
750
    exit(1);
  }

  out_dir += "/";


751
752
753
754
755
  //////////////////////////////://////////
  //         DISCOVER GERMLINES          //
  /////////////////////////////////////////
  if (command == CMD_GERMLINES)
    {
756
      map <char, int> stats_kmer, stats_max;
757
      IKmerStore<KmerAffect> *index = multigermline->index ;
758
759

      // Initialize statistics, with two additional categories
760
761
      index->labels.push_back(make_pair(KmerAffect::getAmbiguous(), AFFECT_AMBIGUOUS_SYMBOL));
      index->labels.push_back(make_pair(KmerAffect::getUnknown(), AFFECT_UNKNOWN_SYMBOL));
762
763
      
      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
764
	{
765
766
767
	  char key = affect_char(it->first.affect) ;
	  stats_kmer[key] = 0 ;
	  stats_max[key] = 0 ;
768
769
	}
      
770
      // init forbidden for .max()
771
772
773
      set<KmerAffect> forbidden;
      forbidden.insert(KmerAffect::getAmbiguous());
      forbidden.insert(KmerAffect::getUnknown());
774
      
775
776
777
      // Loop through all reads

      int nb_reads = 0 ;
778
779
780
      int total_length = 0 ;
      int s = index->getS();

781
782
783
784
785
      while (reads->hasNext())
	{
	  reads->next();
	  nb_reads++;
	  string seq = reads->getSequence().sequence;
786
	  total_length += seq.length() - s + 1;
787

788
	  KmerAffectAnalyser *kaa = new KmerAffectAnalyser(*index, seq);
789
790
791

	  for (int i = 0; i < kaa->count(); i++) 
	    { 
792
793
	      KmerAffect ksa = kaa->getAffectation(i);
	      stats_kmer[affect_char(ksa.affect)]++ ;
794
	    }
795

796
          delete kaa;
797

798
	  CountKmerAffectAnalyser ckaa(*index, seq);
799
800
	  ckaa.setAllowedOverlap(k-1);

801
	  stats_max[affect_char(ckaa.max(forbidden).affect)]++ ;
802

803
804
	}

805
806
      delete reads;

807
808
      // Display statistics

809
810
811
812
      cout << "  <== "
	   << nb_reads << " reads, "
	   << total_length << " kmers"
	   << endl ;
813
      cout << "\t" << " max" << "\t\t" << "        kmers" << "\n" ;
814
815

      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
816
	{
817
818
819
820
	  char key = affect_char(it->first.affect) ;
	  
	  cout << setw(12) << stats_max[key] << " " ;
	  cout << setw(6) << fixed << setprecision(2) <<  (float) stats_max[key] / nb_reads * 100 << "%" ;
821

822
	  cout << "     " ;
823

824
825
	  cout << setw(12) << stats_kmer[key] << " " ;
	  cout << setw(6) << fixed << setprecision(2) <<  (float) stats_kmer[key] / total_length * 100 << "%" ;
826

827
	  cout << "     " << key << " " << it->second << endl ;
828
	}
829
830
      
      delete index;
831
832
833
834
      exit(0);
    }


Mikaël Salson's avatar
Mikaël Salson committed
835
836
837
  ////////////////////////////////////////
  //           CLONE ANALYSIS           //
  ////////////////////////////////////////
838
  if (command == CMD_CLONES || command == CMD_WINDOWS) {
Mikaël Salson's avatar
Mikaël Salson committed
839
840

    //////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
841
    //$$ Kmer Segmentation
Mikaël Salson's avatar
Mikaël Salson committed
842

Mathieu Giraud's avatar
Mathieu Giraud committed
843
844
    cout << endl;
    cout << "Loop through reads, looking for windows" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
845

846
    ofstream *out_segmented = NULL;
Mathieu Giraud's avatar
Mathieu Giraud committed
847
    ofstream *out_unsegmented = NULL;
Mikaël Salson's avatar
Mikaël Salson committed
848
 
Mathieu Giraud's avatar
Mathieu Giraud committed
849
    WindowExtractor we;
850
851
 
    if (output_segmented) {
852
      string f_segmented = out_dir + f_basename + SEGMENTED_FILENAME ;
853
854
855
856
857
      cout << "  ==> " << f_segmented << endl ;
      out_segmented = new ofstream(f_segmented.c_str());
      we.setSegmentedOutput(out_segmented);
    }

Mathieu Giraud's avatar
Mathieu Giraud committed
858
    if (output_unsegmented) {
859
      string f_unsegmented = out_dir + f_basename +  UNSEGMENTED_FILENAME ;
Mathieu Giraud's avatar
Mathieu Giraud committed
860
861
862
863
      cout << "  ==> " << f_unsegmented << endl ;
      out_unsegmented = new ofstream(f_unsegmented.c_str());
      we.setUnsegmentedOutput(out_unsegmented);
    }
864

865
866

    WindowsStorage *windowsStorage = we.extract(reads, multigermline, w, windows_labels);
WebTogz's avatar
WebTogz committed
867
    windowsStorage->setIdToAll();
Mathieu Giraud's avatar
Mathieu Giraud committed
868
    size_t nb_total_reads = we.getNbReads();
Mikaël Salson's avatar
Mikaël Salson committed
869
870


Mathieu Giraud's avatar
Mathieu Giraud committed
871
    //$$ Display statistics on segmentation causes
Mikaël Salson's avatar
Mikaël Salson committed
872

873
874
        
    ostringstream stream_segmentation_info;
Mikaël Salson's avatar
Mikaël Salson committed
875

Mathieu Giraud's avatar
Mathieu Giraud committed
876
877
    int nb_segmented_including_too_short = we.getNbSegmented(TOTAL_SEG_AND_WINDOW) 
      + we.getNbSegmented(TOTAL_SEG_BUT_TOO_SHORT_FOR_THE_WINDOW);
Mikaël Salson's avatar
Mikaël Salson committed
878

879
    stream_segmentation_info << "  ==> segmented " << nb_segmented_including_too_short << " reads"
Mikaël Salson's avatar
Mikaël Salson committed
880
	<< " (" << setprecision(3) << 100 * (float) nb_segmented_including_too_short / nb_total_reads << "%)" 
Mathieu Giraud's avatar
Mathieu Giraud committed
881
882
	<< endl ;

883
    // nb_segmented is the main denominator for the following
Mathieu Giraud's avatar
Mathieu Giraud committed
884
    int nb_segmented = we.getNbSegmented(TOTAL_SEG_AND_WINDOW);
885
    float ratio_segmented = 100 * (float) nb_segmented / nb_total_reads ;
Mikaël Salson's avatar
Mikaël Salson committed
886

887
    stream_segmentation_info << "  ==> found " << windowsStorage->size() << " " << w << "-windows"
Mikaël Salson's avatar
Mikaël Salson committed
888
	<< " in " << nb_segmented << " segments"
889
	<< " (" << setprecision(3) << ratio_segmented << "%)"
Mikaël Salson's avatar
Mikaël Salson committed
890
891
	<< " inside " << nb_total_reads << " sequences" << endl ;
  
892
    // warn if there are too few segmented sequences
893
    if (ratio_segmented < WARN_PERCENT_SEGMENTED)
894
      {
895
896
        stream_segmentation_info << "  ! There are not so many CDR3 windows found in this set of reads." << endl ;
        stream_segmentation_info << "  ! If this is unexpected, check the germline (-G) and try to change seed parameters (-k)." << endl ;
897
898
      }

899
    stream_segmentation_info << "                                  #      av. length" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
900

901
    multigermline->out_stats(stream_segmentation_info);
902
903
    stream_segmentation_info << endl;
    we.out_stats(stream_segmentation_info);
Mikaël Salson's avatar
Mikaël Salson committed
904
    
905
    cout << stream_segmentation_info.str();
Mathieu Giraud's avatar
Mathieu Giraud committed
906
      map <junction, JsonList> json_data_segment ;
Mikaël Salson's avatar
Mikaël Salson committed
907
    
Mikaël Salson's avatar
Mikaël Salson committed
908
909

	//////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
910
	//$$ Sort windows
Mikaël Salson's avatar
Mikaël Salson committed
911
	
Mathieu Giraud's avatar
Mathieu Giraud committed
912
913
        cout << "Sort windows by number of occurrences" << endl;
        windowsStorage->sort();
Mikaël Salson's avatar
Mikaël Salson committed
914
915

	//////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
916
	//$$ Output windows
Mikaël Salson's avatar
Mikaël Salson committed
917
918
	//////////////////////////////////

919
	string f_all_windows = out_dir + f_basename + WINDOWS_FILENAME;
Mathieu Giraud's avatar
Mathieu Giraud committed
920
	cout << "  ==> " << f_all_windows << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
921

Mathieu Giraud's avatar
Mathieu Giraud committed
922
	ofstream out_all_windows(f_all_windows.c_str());
Mathieu Giraud's avatar
Mathieu Giraud committed
923
        windowsStorage->printSortedWindows(out_all_windows);
Mikaël Salson's avatar
Mikaël Salson committed
924
925
926


    //////////////////////////////////
927
928
929
930
931
932
933
    //$$ min_reads_clone (ou label)

    int min_reads_clone_ratio = (int) (ratio_reads_clone * nb_segmented / 100.0);
    cout << "Considering only labeled windows and windows with >= " << min_reads_clone << " reads"
	 << " and with a ratio >= " << ratio_reads_clone << " (" << min_reads_clone_ratio << ")" << endl ;

    int min_reads_clone_final = max(min_reads_clone, min_reads_clone_ratio);
Mathieu Giraud's avatar
Mathieu Giraud committed
934

935
    pair<int, int> info_remove = windowsStorage->keepInterestingWindows((size_t) min_reads_clone_final);
Mikaël Salson's avatar
Mikaël Salson committed
936
	 
Mathieu Giraud's avatar
Mathieu Giraud committed
937
938
    cout << "  ==> keep " <<  windowsStorage->size() << " windows in " << info_remove.second << " reads" ;
    cout << " (" << setprecision(3) << 100 * (float) info_remove.second / nb_total_reads << "%)  " << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
939

940
941
942
943
    if (windowsStorage->size() == 0)
      {
	cout << "  ! No windows with current parameters." << endl;
      }
944

945
946
947
948
949
950
    //////////////////////////////////
    //$$ Clustering
    windowsStorage->sort();
    list<pair <junction, int> > sort_clones = windowsStorage->getSortedList();
    cout << "  ==> " << sort_clones.size() << " clones" << endl ;
    
951
    list <list <junction> > clones_windows;
952
    comp_matrix comp=comp_matrix(sort_clones);
953
      
954
    if (command == CMD_CLONES) {
Mikaël Salson's avatar
Mikaël Salson committed
955
956
957

    if (epsilon || forced_edges.size())
      {
Mathieu Giraud's avatar
Mathieu Giraud committed
958
	cout << "Cluster similar windows" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
959
960
961

	if (load_comp==1) 
	  {
962
	    comp.load((out_dir+f_basename + "." + comp_filename).c_str());
Mikaël Salson's avatar
Mikaël Salson committed
963
964
965
	  }
	else
	  {
Mathieu Giraud's avatar
Mathieu Giraud committed
966
	    comp.compare( cout, cluster_cost);
Mikaël Salson's avatar
Mikaël Salson committed
967
968
969
970
	  }
	
	if (save_comp==1)
	  {
971
	    comp.save(( out_dir+f_basename + "." + comp_filename).c_str());
Mikaël Salson's avatar
Mikaël Salson committed
972
973
	  }
       
Mathieu Giraud's avatar
Mathieu Giraud committed
974
	clones_windows  = comp.cluster(forced_edges, w, cout, epsilon, minPts) ;
975
	comp.stat_cluster(clones_windows, cout );
Mikaël Salson's avatar
Mikaël Salson committed
976
	comp.del();
977
	cout << "  ==> " << clones_windows.size() << " clusters" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
978
979
      } 
    else
980 </