vidjil.cpp 45.6 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
#define WINDOWS_FILENAME ".windows.fa"
#define SEGMENTED_FILENAME ".segmented.vdj.fa"
92
#define UNSEGMENTED_FILENAME ".unsegmented.vdj.fa"
93
#define AFFECTS_FILENAME ".affects"
94
95
96
#define EDGES_FILENAME ".edges"
#define COMP_FILENAME "comp.vidjil"
#define JSON_SUFFIX ".vidjil"
Mikaël Salson's avatar
Mikaël Salson committed
97
98
99

// "tests/data/leukemia.fa" 

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

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

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

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

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

#define DEFAULT_CLUSTER_COST  Cluster
#define DEFAULT_SEGMENT_COST   VDJ

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

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

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

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

using namespace std ;

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

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

extern int optind, optopt, opterr;

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

  cerr << "Command selection" << endl
145
146
147
148
149
       << "  -c <command>"
       << "\t"     << COMMAND_CLONES    << "  \t locus detection, window extraction, clone gathering (default command, most efficient, all outputs)" << endl
       << "  \t\t" << COMMAND_WINDOWS   << "  \t locus detection, window extraction" << endl
       << "  \t\t" << COMMAND_SEGMENT   << "  \t detailed V(D)J segmentation (not recommended)" << endl
       << "  \t\t" << COMMAND_GERMLINES << "  \t statistics on k-mers in different germlines" << endl
Mikaël Salson's avatar
Mikaël Salson committed
150
151
       << endl       

152
       << "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
153
       << "  -V <file>     V germline multi-fasta file" << endl
154
       << "  -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
155
       << "  -J <file>     J germline multi-fasta file" << endl
156
       << "  -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
157
       << "  -g <path>     multiple germlines (in the path <path>, takes TRA, TRB, TRG, TRD, IGH, IGK and IGL and sets window prediction parameters)" << endl
158
       << "  -i            multiple germlines, also incomplete rearrangements (must be used with -g)" << endl
159
       << endl ;
160

161
162
  if (advanced)
  cerr << "Experimental options (do not use)" << endl
163
       << "  -I            ignore k-mers common to different germline systems (experimental, must be used with -g, do not use)" << endl
164
       << "  -1            use a unique index for all germline systems (experimental, must be used with -g, do not use)" << endl
165
       << "  -!            keep unsegmented reads as clones, taking for junction the complete sequence, to be used on very small datasets (for example -!AX 20)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
166
167
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
168
       << "Window prediction" << endl
Mikaël Salson's avatar
Mikaël Salson committed
169
#ifndef NO_SPACED_SEEDS
170
       << "  (use either -s or -k option, but not both)" << endl
171
       << "  (all these options, except -w, are overriden when using -g)" << endl
172
173
       << "  -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
174
#endif
175
       << "  -k <int>      k-mer size used for the V/J affectation (default: 10, 12, 13, depends on germline)" << endl
176
177
178
#ifndef NO_SPACED_SEEDS
       << "                (using -k option is equivalent to set with -s a contiguous seed with only '#' characters)" << endl
#endif
179
180
181
       << "  -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
182
183
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
184
       << "Window annotations" << endl
185
       << "  -l <file>     labels for some windows -- these windows will be kept even if -r/-% thresholds are not reached" << endl
186
       << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
187

188
  cerr << "Limits to report a clone (or a window)" << endl
189
190
       << "  -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
191
192
       << endl

193
       << "Limits to further analyze some clones" << endl
194
       << "  -y <nb>       maximal number of clones computed with a representative ('" << NO_LIMIT << "': no limit) (default: " << DEFAULT_MAX_REPRESENTATIVES << ")" << endl
195
       << "  -z <nb>       maximal number of clones to be segmented ('" << NO_LIMIT << "': no limit, do not use) (default: " << DEFAULT_MAX_CLONES << ")" << endl
196
       << "  -A            reports and segments all clones (-r 0 -% 0 -y " << NO_LIMIT << " -z " << NO_LIMIT << "), to be used only on very small datasets (for example -AX 20)" << endl
197
198
       << "  -x <nb>       maximal number of reads to process ('" << NO_LIMIT << "': no limit, default), only first reads" << endl
       << "  -X <nb>       maximal number of reads to process ('" << NO_LIMIT << "': no limit, default), sampled reads" << endl
199
       << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
200

201
202
  if (advanced)
  cerr << "Fine segmentation options (second pass, see warning in doc/algo.org)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
203
       << "  -f <string>   use custom Cost for fine segmenter : format \"match, subst, indels, homo, del_end\" (default "<<VDJ<<" )"<< endl
204
       << "  -3            CDR3 detection (experimental)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
205
206
       << endl

207
       << "Additional clustering (experimental)" << endl
208
209
210
211
212
213
       << "  -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
214
       << endl ;
215

216
  cerr << "Detailed output per read (not recommended, large files)" << endl
217
218
       << "  -U            output segmented reads (in " << SEGMENTED_FILENAME << " file)" << endl
       << "  -u            output unsegmented reads (in " << UNSEGMENTED_FILENAME << " file)" << endl
219
       << "  -K            output detailed k-mer affectation on all reads (in " << AFFECTS_FILENAME << " file) (use only for debug, for example -KX 100)" << endl
220
221
       << endl
 
Mikaël Salson's avatar
Mikaël Salson committed
222
       << "Output" << endl
223
       << "  -o <dir>      output directory (default: " << DEFAULT_OUT_DIR << ")" <<  endl
224
       << "  -b <string>   output basename (by default basename of the input file)" << endl
Mikaël Salson's avatar
Mikaël Salson committed
225
    
226
       << "  -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
227
228
229
       << "  -v            verbose mode" << endl
       << endl        

230
231
       << "  -h            help" << endl
       << "  -H            help, including experimental and advanced options" << endl
232
233
234
       << "The full help is available in the doc/algo.org file."
       << endl

Mikaël Salson's avatar
Mikaël Salson committed
235
       << endl 
Mathieu Giraud's avatar
Mathieu Giraud committed
236
       << "Examples (see doc/algo.org)" << endl
Mathieu Giraud's avatar
Mathieu Giraud committed
237
       << "  " << progname << " -c clones   -G germline/IGH  -r 5          data/Stanford_S22.fasta" << endl
238
239
       << "  " << progname << " -c clones   -g germline      -r 5          data/Stanford_S22.fasta   # (detect the locus for each read)" << endl
       << "  " << progname << " -c windows  -g germline      -u -U         data/Stanford_S22.fasta   # (detect the locus, splits the reads into two (large) files)" << endl
Mathieu Giraud's avatar
Mathieu Giraud committed
240
       << "  " << progname << " -c segment  -G germline/IGH                data/Stanford_S22.fasta   # (only for testing)" << endl
241
       << "  " << progname << " -c germlines                               data/Stanford_S22.fasta" << endl
Mikaël Salson's avatar
Mikaël Salson committed
242
243
244
245
    ;
  exit(1);
}

Mathieu Giraud's avatar
Mathieu Giraud committed
246
247
248
249
250
251

int atoi_NO_LIMIT(char *optarg)
{
  return strcmp(NO_LIMIT, optarg) ? atoi(optarg) : -1 ;
}

Mikaël Salson's avatar
Mikaël Salson committed
252
253
int main (int argc, char **argv)
{
254
  cout << "# Vidjil -- V(D)J recombinations analysis <http://www.vidjil.org/>" << endl
255
256
       << "# 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
257
258
259
260
261
       << 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
262
263
       << endl
       << "# Please cite http://biomedcentral.com/1471-2164/15/409 if you use Vidjil." 
Mikaël Salson's avatar
Mikaël Salson committed
264
265
       << endl ;

Mathieu Giraud's avatar
Mathieu Giraud committed
266
267
  //$$ options: defaults

268
  string germline_system = "" ;
269
270
271
272
273
  
  list <string> f_reps_V ;
  list <string> f_reps_D ;
  list <string> f_reps_J ;

Mikaël Salson's avatar
Mikaël Salson committed
274
275
  string f_reads = DEFAULT_READS ;
  string seed = DEFAULT_SEED ;
276
  string f_basename = "";
Mikaël Salson's avatar
Mikaël Salson committed
277

278
  string out_dir = DEFAULT_OUT_DIR;
Mikaël Salson's avatar
Mikaël Salson committed
279
280
281
282
  
  string comp_filename = COMP_FILENAME;

  int k = DEFAULT_K ;
Mikaël Salson's avatar
Mikaël Salson committed
283
284
285
  int w = 0 ;
  int default_w = DEFAULT_W ;

Mikaël Salson's avatar
Mikaël Salson committed
286
287
288
289
  int epsilon = DEFAULT_EPSILON ;
  int minPts = DEFAULT_MINPTS ;
  Cost cluster_cost = DEFAULT_CLUSTER_COST ;
  Cost segment_cost = DEFAULT_SEGMENT_COST ;
290
  bool detect_CDR3 = false;
Mikaël Salson's avatar
Mikaël Salson committed
291
292
293
294
295
  
  int save_comp = 0;
  int load_comp = 0;
  
  int verbose = 0 ;
296
  int command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
297

298
  int max_representatives = DEFAULT_MAX_REPRESENTATIVES ;
299
300
301
  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
302
303
  // int average_deletion = 4;     // Average number of deletion in V or J

304
  int max_reads_processed = -1;
305
  int max_reads_processed_sample = -1;
306

Mathieu Giraud's avatar
Mathieu Giraud committed
307
  float ratio_representative = DEFAULT_RATIO_REPRESENTATIVE;
Mikaël Salson's avatar
Mikaël Salson committed
308
  unsigned int max_auditionned = DEFAULT_MAX_AUDITIONED;
Mathieu Giraud's avatar
Mathieu Giraud committed
309

Mikaël Salson's avatar
Mikaël Salson committed
310
311
312
313
314
  // 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;
315
  bool output_segmented = false;
Mathieu Giraud's avatar
Mathieu Giraud committed
316
  bool output_unsegmented = false;
317
  bool output_affects = false;
318
319
  bool keep_unsegmented_as_clone = false;

320
  bool multi_germline = false;
321
  bool multi_germline_incomplete = false;
322
  bool multi_germline_mark = false;
323
  bool multi_germline_one_index_per_germline = true;
324
  string multi_germline_file = DEFAULT_MULTIGERMLINE;
Mikaël Salson's avatar
Mikaël Salson committed
325
326
327

  string forced_edges = "" ;

Mathieu Giraud's avatar
Mathieu Giraud committed
328
  string windows_labels_file = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
329
330
331

  char c ;

332
333
  int options_s_k = 0 ;

WebTogz's avatar
WebTogz committed
334
335
336
  //JsonArray which contains the Levenshtein distances
  JsonArray jsonLevenshtein;

Mathieu Giraud's avatar
Mathieu Giraud committed
337
338
  //$$ options: getopt

339

340
  while ((c = getopt(argc, argv, "A!x:X:hHaiI1g:G:V:D:J:k:r:vw:e:C:f:l:c:m:M:N:s:b:Sn:o:L%:y:z:uUK3")) != EOF)
Mikaël Salson's avatar
Mikaël Salson committed
341
342
343
344

    switch (c)
      {
      case 'h':
345
346
347
348
        usage(argv[0], false);

      case 'H':
        usage(argv[0], true);
349

Mikaël Salson's avatar
Mikaël Salson committed
350
      case 'c':
351
352
        if (!strcmp(COMMAND_CLONES,optarg))
          command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
353
354
        else if (!strcmp(COMMAND_SEGMENT,optarg))
          command = CMD_SEGMENT;
Mathieu Giraud's avatar
Mathieu Giraud committed
355
356
        else if (!strcmp(COMMAND_WINDOWS,optarg))
          command = CMD_WINDOWS;
357
358
        else if (!strcmp(COMMAND_GERMLINES,optarg))
          command = CMD_GERMLINES;
Mikaël Salson's avatar
Mikaël Salson committed
359
360
        else {
          cerr << "Unknwown command " << optarg << endl;
361
	  usage(argv[0], false);
Mikaël Salson's avatar
Mikaël Salson committed
362
363
        }
        break;
364

Mikaël Salson's avatar
Mikaël Salson committed
365
366
367
368

      // Germline

      case 'V':
369
	f_reps_V.push_back(optarg);
370
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
371
372
373
	break;

      case 'D':
374
	f_reps_D.push_back(optarg);
375
376
377
	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
378
379
380
	break;
        
      case 'J':
381
	f_reps_J.push_back(optarg);
382
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
383
384
	break;

385
      case 'g':
386
387
	multi_germline = true;
	multi_germline_file = string(optarg);
388
	germline_system = "multi" ;
389
	break;
390
391
392
393

      case 'i':
	multi_germline_incomplete = true;
	break;
394
395
396
397

      case 'I':
        multi_germline_mark = true;
	break;
398
399
400
401

      case '1':
        multi_germline_one_index_per_germline = false ;
        break;
402
        
Mikaël Salson's avatar
Mikaël Salson committed
403
      case 'G':
Mikaël Salson's avatar
Mikaël Salson committed
404
	germline_system = string(optarg);
405
	f_reps_V.push_back((germline_system + "V.fa").c_str()) ;
406
407
408
409
410
        // 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)
411
412
413
414
415
416
            {
              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 ;
            }
417
        }
418
	f_reps_J.push_back((germline_system + "J.fa").c_str()) ;
419
	germline_system = extract_basename(germline_system);
420

Mikaël Salson's avatar
Mikaël Salson committed
421
422
423
424
	break;

      // Algorithm

425
426
427
428
429
430
431
432
433
434
      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
435
436
437
      case 'k':
	k = atoi(optarg);
	seed = seed_contiguous(k);
438
	options_s_k++ ;
Mikaël Salson's avatar
Mikaël Salson committed
439
440
441
442
443
444
445
446
447
448
449
450
451
452
        break;

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

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

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

453
454
455
456
      case '!':
        keep_unsegmented_as_clone = true;
        break;

457
458
      // Output 

Mikaël Salson's avatar
Mikaël Salson committed
459
460
461
462
      case 'o':
        out_dir = optarg ;
        break;

463
464
      case 'b':
        f_basename = optarg;
Mikaël Salson's avatar
Mikaël Salson committed
465
466
        break;

467
468
469
470
471
472
473
474
      case 'a':
	output_sequences_by_cluster = true;
	break;

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

475
476
      // Limits

Mikaël Salson's avatar
Mikaël Salson committed
477
478
479
480
      case '%':
	ratio_reads_clone = atof(optarg);
	break;

481
      case 'r':
Mikaël Salson's avatar
Mikaël Salson committed
482
483
484
	min_reads_clone = atoi(optarg);
        break;

485
      case 'y':
Mathieu Giraud's avatar
Mathieu Giraud committed
486
	max_representatives = atoi_NO_LIMIT(optarg);
487
488
        break;

Mikaël Salson's avatar
Mikaël Salson committed
489
      case 'z':
Mathieu Giraud's avatar
Mathieu Giraud committed
490
	max_clones = atoi_NO_LIMIT(optarg);
Mikaël Salson's avatar
Mikaël Salson committed
491
        break;
492
493
494

      case 'A': // --all
	ratio_reads_clone = 0 ;
495
496
497
	min_reads_clone = 1 ;
	max_representatives = -1 ;
	max_clones = -1 ;
498
499
	break ;

500
      case 'X':
501
502
503
504
        max_reads_processed_sample = atoi_NO_LIMIT(optarg);
        break;

      case 'x':
Mathieu Giraud's avatar
Mathieu Giraud committed
505
        max_reads_processed = atoi_NO_LIMIT(optarg);
506
        break;
507

508
509
510
511
      case 'l':
	windows_labels_file = optarg; 
	break;

512
      // Clustering
513
514
515
516

      case 'e':
	forced_edges = optarg;
	break;
Mikaël Salson's avatar
Mikaël Salson committed
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
	
      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;
	
538
      // Fine segmentation
539
540
541
542
      case '3':
        detect_CDR3 = true;
        break;
        
543
      case 'f':
Mikaël Salson's avatar
Mikaël Salson committed
544
545
	segment_cost=strToCost(optarg, VDJ);
        break;
Mathieu Giraud's avatar
Mathieu Giraud committed
546
547
548
549

      case 'u':
        output_unsegmented = true;
        break;
550
551
552
      case 'U':
        output_segmented = true;
        break;
553
554
555
      case 'K':
        output_affects = true;
        break;
Mikaël Salson's avatar
Mikaël Salson committed
556
557
      }

558
559
560

  //$$ options: post-processing+display

561
562
563

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

Mikaël Salson's avatar
Mikaël Salson committed
568
569
570
571
572
  // If there was no -w option, then w is either DEFAULT_W or DEFAULT_W_D
  if (w == 0)
    w = default_w ;

  
573
574
  if (options_s_k > 1)
    {
575
      cerr << ERROR_STRING << "Use at most one -s or -k option." << endl ;
576
577
578
      exit(1);
    }

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

Mikaël Salson's avatar
Mikaël Salson committed
581
582
583
584
585
586
587
588
589
590
591
592
593
  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
    {
594
      cerr << ERROR_STRING << "Wrong number of arguments." << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
595
596
      exit(1);
    }
Mathieu Giraud's avatar
Mathieu Giraud committed
597

598
  size_t min_cover_representative = (size_t) (min_reads_clone < (int) max_auditionned ? min_reads_clone : max_auditionned) ;
599

600
601
602
603
604
605
  // Default seeds

#ifndef NO_SPACED_SEEDS
  if (k == DEFAULT_K)
    {
      if (germline_system.find("TRA") != string::npos)
606
	seed = SEED_S13 ;
607
608
609

      else if ((germline_system.find("TRB") != string::npos)
	       || (germline_system.find("IGH") != string::npos))
610
	seed = SEED_S12 ;
611
      else // TRD, TRG, IGK, IGL, custom, multi
612
	seed = SEED_S10 ;
613
614
615
616
617

      k = seed_weight(seed);
    }
#else
  {
618
    cerr << ERROR_STRING << "Vidjil was compiled with NO_SPACED_SEEDS: please provide a -k option." << endl;
619
620
621
622
623
    exit(1) ;
  }
#endif
	  

Mathieu Giraud's avatar
Mathieu Giraud committed
624
625
626
627
#ifndef NO_SPACED_SEEDS
  // Check seed buffer  
  if (seed.size() >= MAX_SEED_SIZE)
    {
628
      cerr << ERROR_STRING << "Seed size is too large (MAX_SEED_SIZE)." << endl ;
Mathieu Giraud's avatar
Mathieu Giraud committed
629
630
631
632
      exit(1);
    }
#endif

633
634
635

  if (w < seed_weight(seed))
    {
636
      cerr << ERROR_STRING << "Too small -w. The window size should be at least equal to the seed size (" << seed_weight(seed) << ")." << endl;
637
638
639
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
640
641
642
643
  // 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) {
644
    cerr << ERROR_STRING << "Directory creation: " << out_dir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
645
646
647
    exit(2);
  }

Mikaël Salson's avatar
Mikaël Salson committed
648
649
  const char *outseq_cstr = out_seqdir.c_str();
  if (mkpath(outseq_cstr, 0755) == -1) {
650
    cerr << ERROR_STRING << "Directory creation: " << out_seqdir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
651
652
653
    exit(2);
  }

654
655
656
657
658
  // 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
659
660
661
  out_dir += "/" ;

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

  switch(command) {
Mathieu Giraud's avatar
Mathieu Giraud committed
665
  case CMD_WINDOWS: cout << "Extracting windows" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
666
    break;
667
  case CMD_CLONES: cout << "Analysing clones" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
668
669
670
    break;
  case CMD_SEGMENT: cout << "Segmenting V(D)J" << endl;
    break;
671
672
  case CMD_GERMLINES: cout << "Discovering germlines" << endl;
    break;
Mikaël Salson's avatar
Mikaël Salson committed
673
674
  }

Mathieu Giraud's avatar
Mathieu Giraud committed
675
  cout << "Command line: ";
Mikaël Salson's avatar
Mikaël Salson committed
676
  for (int i=0; i < argc; i++) {
Mathieu Giraud's avatar
Mathieu Giraud committed
677
    cout << argv[i] << " ";
Mikaël Salson's avatar
Mikaël Salson committed
678
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
679
  cout << endl;
Mikaël Salson's avatar
Mikaël Salson committed
680
681
682
683
684
685
686
687
688
689
690
691

  //////////////////////////////////
  // 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
692
  cout << "# " << time_buffer << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
693
694
695
696
697


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

698
  string soft_version = "vidjil ";
Mikaël Salson's avatar
Mikaël Salson committed
699
#ifdef RELEASE_TAG
Mathieu Giraud's avatar
Mathieu Giraud committed
700
  cout << "# version: vidjil " << RELEASE_TAG << endl ;
701
  soft_version.append(RELEASE_TAG);
Mikaël Salson's avatar
Mikaël Salson committed
702
#else
703
704
705
  cout << "# development version" << endl ;
#ifdef GIT_VERSION
  cout << "# git: " << GIT_VERSION << endl ;
706
  soft_version.append("dev ");
707
  soft_version.append(GIT_VERSION);
708
#endif
709
#endif
710

711
712
  //////////////////////////////////
  // Warning for non-optimal use
713

714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
  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 ;
    }
735

736
737
738
  /////////////////////////////////////////
  //            LOAD GERMLINES           //
  /////////////////////////////////////////
739

740
741
742
743
744
745
746
  if (command == CMD_GERMLINES)
    {
      multi_germline = true ;
      multi_germline_one_index_per_germline = false ;
    }

  MultiGermline *multigermline = new MultiGermline(multi_germline_one_index_per_germline);
747

748
    {
749
      cout << "Load germlines and build Kmer indexes" << endl ;
750
751
752
753
    
      if (multi_germline)
	{
	  multigermline->build_default_set(multi_germline_file);
754
755
          if (multi_germline_incomplete)
            multigermline->build_incomplete_set(multi_germline_file);
756
757
758
759
760
761
	}
      else
	{
	  // Custom germline
	  Germline *germline;
	  germline = new Germline(germline_system, 'X',
762
763
764
                                  f_reps_V, f_reps_D, f_reps_J, 
                                  delta_min, delta_max);

765
          germline->new_index(seed);
766

767
768
769
	  multigermline->insert(germline);
	}
    }
770

771
    cout << endl ;
772

773
774
775
    if (!multi_germline_one_index_per_germline)
      multigermline->build_with_one_index(seed);

776
777
778
    if (multi_germline_mark)
      multigermline->mark_cross_germlines_as_ambiguous();
    
779
780
781
782
    cout << "Germlines loaded" << endl ;
    cout << *multigermline ;
    cout << endl ;
    
783
784
785
786
787
788
789
  //////////////////////////////////
  //$$ Read sequence files
 
  OnlineFasta *reads;

  try {
    reads = new OnlineFasta(f_reads, 1, " ");
790
  } catch (const invalid_argument e) {
791
    cerr << ERROR_STRING << "Vidjil cannot open reads file " << f_reads << ": " << e.what() << endl;
792
793
794
795
796
797
    exit(1);
  }

  out_dir += "/";


798
799
800
801
802
  //////////////////////////////://////////
  //         DISCOVER GERMLINES          //
  /////////////////////////////////////////
  if (command == CMD_GERMLINES)
    {
803
      map <char, int> stats_kmer, stats_max;
804
      IKmerStore<KmerAffect> *index = multigermline->index ;
805
806

      // Initialize statistics, with two additional categories
807
808
      index->labels.push_back(make_pair(KmerAffect::getAmbiguous(), AFFECT_AMBIGUOUS_SYMBOL));
      index->labels.push_back(make_pair(KmerAffect::getUnknown(), AFFECT_UNKNOWN_SYMBOL));
809
810
      
      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
811
	{
812
813
814
	  char key = affect_char(it->first.affect) ;
	  stats_kmer[key] = 0 ;
	  stats_max[key] = 0 ;
815
816
	}
      
817
      // init forbidden for .max()
818
819
820
      set<KmerAffect> forbidden;
      forbidden.insert(KmerAffect::getAmbiguous());
      forbidden.insert(KmerAffect::getUnknown());
821
      
822
823
824
      // Loop through all reads

      int nb_reads = 0 ;
825
826
827
      int total_length = 0 ;
      int s = index->getS();

828
829
830
831
832
      while (reads->hasNext())
	{
	  reads->next();
	  nb_reads++;
	  string seq = reads->getSequence().sequence;
833
	  total_length += seq.length() - s + 1;
834

835
	  KmerAffectAnalyser *kaa = new KmerAffectAnalyser(*index, seq);
836
837
838

	  for (int i = 0; i < kaa->count(); i++) 
	    { 
839
840
	      KmerAffect ksa = kaa->getAffectation(i);
	      stats_kmer[affect_char(ksa.affect)]++ ;
841
	    }
842

843
          delete kaa;
844

845
	  CountKmerAffectAnalyser ckaa(*index, seq);
846
847
	  ckaa.setAllowedOverlap(k-1);

848
	  stats_max[affect_char(ckaa.max(forbidden).affect)]++ ;
849

850
851
	}

852
853
      delete reads;

854
855
      // Display statistics

856
857
858
859
      cout << "  <== "
	   << nb_reads << " reads, "
	   << total_length << " kmers"
	   << endl ;
860
      cout << "\t" << " max" << "\t\t" << "        kmers" << "\n" ;
861
862

      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
863
	{
864
865
866
867
	  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 << "%" ;
868

869
	  cout << "     " ;
870

871
872
	  cout << setw(12) << stats_kmer[key] << " " ;
	  cout << setw(6) << fixed << setprecision(2) <<  (float) stats_kmer[key] / total_length * 100 << "%" ;
873

874
	  cout << "     " << key << " " << it->second << endl ;
875
	}
876
877
      
      delete index;
878
879
880
881
      exit(0);
    }


Mikaël Salson's avatar
Mikaël Salson committed
882
883
884
  ////////////////////////////////////////
  //           CLONE ANALYSIS           //
  ////////////////////////////////////////
885
  if (command == CMD_CLONES || command == CMD_WINDOWS) {
Mikaël Salson's avatar
Mikaël Salson committed
886
887

    //////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
888
    //$$ Kmer Segmentation
Mikaël Salson's avatar
Mikaël Salson committed
889

890
891
892
893
894
895
896
897
    int only_nth_read = 1 ;
    if (max_reads_processed_sample > 0)
      {
        only_nth_read = nb_sequences_in_fasta(f_reads) / max_reads_processed_sample;
        max_reads_processed = max_reads_processed_sample ;
        cout << "Processing every " << only_nth_read << "th read" << endl ;
      }

Mathieu Giraud's avatar
Mathieu Giraud committed
898
899
    cout << endl;
    cout << "Loop through reads, looking for windows" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
900

901
    ofstream *out_segmented = NULL;
Mathieu Giraud's avatar
Mathieu Giraud committed
902
    ofstream *out_unsegmented = NULL;
903
    ofstream *out_affects = NULL;
Mikaël Salson's avatar
Mikaël Salson committed
904
 
Mathieu Giraud's avatar
Mathieu Giraud committed
905
    WindowExtractor we;
906
907
 
    if (output_segmented) {
908
      string f_segmented = out_dir + f_basename + SEGMENTED_FILENAME ;
909
910
911
912
913
      cout << "  ==> " << f_segmented << endl ;
      out_segmented = new ofstream(f_segmented.c_str());
      we.setSegmentedOutput(out_segmented);
    }

Mathieu Giraud's avatar
Mathieu Giraud committed
914
    if (output_unsegmented) {
915
      string f_unsegmented = out_dir + f_basename + UNSEGMENTED_FILENAME ;
Mathieu Giraud's avatar
Mathieu Giraud committed
916
917
918
919
      cout << "  ==> " << f_unsegmented << endl ;
      out_unsegmented = new ofstream(f_unsegmented.c_str());
      we.setUnsegmentedOutput(out_unsegmented);
    }
920

921
922
923
924
925
926
927
    if (output_affects) {
      string f_affects = out_dir + f_basename + AFFECTS_FILENAME ;
      cout << "  ==> " << f_affects << endl ;
      out_affects = new ofstream(f_affects.c_str());
      we.setAffectsOutput(out_affects);
    }

928
    WindowsStorage *windowsStorage = we.extract(reads, multigermline, w, windows_labels, max_reads_processed, only_nth_read, keep_unsegmented_as_clone);
WebTogz's avatar
WebTogz committed
929
    windowsStorage->setIdToAll();
Mathieu Giraud's avatar
Mathieu Giraud committed
930
    size_t nb_total_reads = we.getNbReads();
Mikaël Salson's avatar
Mikaël Salson committed
931
932


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

935
936
        
    ostringstream stream_segmentation_info;
Mikaël Salson's avatar
Mikaël Salson committed
937

Mathieu Giraud's avatar
Mathieu Giraud committed
938
939
    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
940

941
    stream_segmentation_info << "  ==> segmented " << nb_segmented_including_too_short << " reads"
Mikaël Salson's avatar
Mikaël Salson committed
942
	<< " (" << setprecision(3) << 100 * (float) nb_segmented_including_too_short / nb_total_reads << "%)" 
Mathieu Giraud's avatar
Mathieu Giraud committed
943
944
	<< endl ;

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

949
    stream_segmentation_info << "  ==> found " << windowsStorage->size() << " " << w << "-windows"
Mikaël Salson's avatar
Mikaël Salson committed
950
	<< " in " << nb_segmented << " segments"
951
	<< " (" << setprecision(3) << ratio_segmented << "%)"
Mikaël Salson's avatar
Mikaël Salson committed
952
953
	<< " inside " << nb_total_reads << " sequences" << endl ;
  
954
    // warn if there are too few segmented sequences
955
    if (ratio_segmented < WARN_PERCENT_SEGMENTED)
956
      {
957
        stream_segmentation_info << "  ! There are not so many CDR3 windows found in this set of reads." << endl ;
958
        stream_segmentation_info << "  ! Please check the unsegmentation causes below and refer to the documentation." << endl ;
959
960
      }

961
962
963
    cout << "Build clone stats" << endl;
    windowsStorage->fillStatsClones();
    
964
    multigermline->out_stats(stream_segmentation_info);
965
966
    stream_segmentation_info << endl;
    we.out_stats(stream_segmentation_info);
Mikaël Salson's avatar
Mikaël Salson committed
967
    
968
    cout << stream_segmentation_info.str();
Mathieu Giraud's avatar
Mathieu Giraud committed
969
      map <junction, JsonList> json_data_segment ;
Mikaël Salson's avatar
Mikaël Salson committed
970
    
Mikaël Salson's avatar
Mikaël Salson committed
971
972

	//////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
973
	//$$ Sort windows
Mikaël Salson's avatar
Mikaël Salson committed
974
	
Mathieu Giraud's avatar
Mathieu Giraud committed
975
976
        cout << "Sort windows by number of occurrences" << endl;
        windowsStorage->sort();
Mikaël Salson's avatar
Mikaël Salson committed
977
978

	//////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
979
	//$$ Output windows
Mikaël Salson's avatar
Mikaël Salson committed
980
981
	//////////////////////////////////

982
	string f_all_windows = out_dir + f_basename + WINDOWS_FILENAME;