vidjil.cpp 47.8 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
101
#define DEFAULT_W      50
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

extern int optind, optopt, opterr;

139
void usage(char *progname, bool advanced)
Mikaël Salson's avatar
Mikaël Salson committed
140
{
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
146
147
148
       << "  -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
149
150
       << endl       

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

160
161
  if (advanced)
  cerr << "Experimental options (do not use)" << endl
162
       << "  -I            ignore k-mers common to different germline systems (experimental, must be used with -g, do not use)" << endl
163
       << "  -1            use a unique index for all germline systems (experimental, must be used with -g, do not use)" << endl
164
       << "  -2            try to detect unexpected recombinations (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
       << "  -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
181
       << "  -w <int>      w-mer size used for the length of the extracted window (default: " << DEFAULT_W << ")" << endl
182
       << "  -e <float>    maximal e-value for determining if a segmentation can be trusted (default: " << THRESHOLD_NB_EXPECTED << ")" << endl
Mikaël Salson's avatar
Mikaël Salson committed
183
184
       << endl

185
186
187
       << "Labeled windows (these windows will be kept even if -r/-% thresholds are not reached)" << endl
       << "  -W <window>   label the given window" << endl
       << "  -l <file>     label a set of windows given in <file>" << endl
188
       << "  -F            filter -- keep only the labeled windows" << endl
189
       << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
190

191
  cerr << "Limits to report a clone (or a window)" << endl
192
193
       << "  -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
194
195
       << endl

196
       << "Limits to further analyze some clones" << endl
197
       << "  -y <nb>       maximal number of clones computed with a representative ('" << NO_LIMIT << "': no limit) (default: " << DEFAULT_MAX_REPRESENTATIVES << ")" << endl
198
       << "  -z <nb>       maximal number of clones to be segmented ('" << NO_LIMIT << "': no limit, do not use) (default: " << DEFAULT_MAX_CLONES << ")" << endl
199
       << "  -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
200
201
       << "  -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
202
       << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
203

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

210
       << "Additional clustering (experimental)" << endl
211
       << "  -E <file>     manual clustering -- a file used to force some specific edges" << endl
212
213
214
215
216
       << "  -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
217
       << endl ;
218

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

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

Mikaël Salson's avatar
Mikaël Salson committed
238
       << endl 
Mathieu Giraud's avatar
Mathieu Giraud committed
239
       << "Examples (see doc/algo.org)" << endl
Mathieu Giraud's avatar
Mathieu Giraud committed
240
       << "  " << progname << " -c clones   -G germline/IGH  -r 5          data/Stanford_S22.fasta" << endl
241
242
       << "  " << 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
243
       << "  " << progname << " -c segment  -G germline/IGH                data/Stanford_S22.fasta   # (only for testing)" << endl
244
       << "  " << progname << " -c germlines                               data/Stanford_S22.fasta" << endl
Mikaël Salson's avatar
Mikaël Salson committed
245
246
247
248
    ;
  exit(1);
}

Mathieu Giraud's avatar
Mathieu Giraud committed
249
250
251

int atoi_NO_LIMIT(char *optarg)
{
252
253
  return strcmp(NO_LIMIT, optarg) ? atoi(optarg) : NO_LIMIT_VALUE ;
}
254
double atof_NO_LIMIT(char *optarg)
255
256
{
  return strcmp(NO_LIMIT, optarg) ? atof(optarg) : NO_LIMIT_VALUE ;
Mathieu Giraud's avatar
Mathieu Giraud committed
257
258
}

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

Mathieu Giraud's avatar
Mathieu Giraud committed
273
274
  //$$ options: defaults

275
  string germline_system = "" ;
276
277
278
279
280
  
  list <string> f_reps_V ;
  list <string> f_reps_D ;
  list <string> f_reps_J ;

Mikaël Salson's avatar
Mikaël Salson committed
281
282
  string f_reads = DEFAULT_READS ;
  string seed = DEFAULT_SEED ;
283
  string f_basename = "";
Mikaël Salson's avatar
Mikaël Salson committed
284

285
  string out_dir = DEFAULT_OUT_DIR;
Mikaël Salson's avatar
Mikaël Salson committed
286
287
288
289
  
  string comp_filename = COMP_FILENAME;

  int k = DEFAULT_K ;
290
  int w = DEFAULT_W ;
Mikaël Salson's avatar
Mikaël Salson committed
291

Mikaël Salson's avatar
Mikaël Salson committed
292
293
294
295
  int epsilon = DEFAULT_EPSILON ;
  int minPts = DEFAULT_MINPTS ;
  Cost cluster_cost = DEFAULT_CLUSTER_COST ;
  Cost segment_cost = DEFAULT_SEGMENT_COST ;
296
  bool detect_CDR3 = false;
Mikaël Salson's avatar
Mikaël Salson committed
297
298
299
300
301
  
  int save_comp = 0;
  int load_comp = 0;
  
  int verbose = 0 ;
302
  int command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
303

304
  int max_representatives = DEFAULT_MAX_REPRESENTATIVES ;
305
306
307
  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
308
309
  // int average_deletion = 4;     // Average number of deletion in V or J

310
  int max_reads_processed = -1;
311
  int max_reads_processed_sample = -1;
312

Mathieu Giraud's avatar
Mathieu Giraud committed
313
  float ratio_representative = DEFAULT_RATIO_REPRESENTATIVE;
Mikaël Salson's avatar
Mikaël Salson committed
314
  unsigned int max_auditionned = DEFAULT_MAX_AUDITIONED;
Mathieu Giraud's avatar
Mathieu Giraud committed
315

Mikaël Salson's avatar
Mikaël Salson committed
316
317
318
319
320
  // 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;
321
  bool output_segmented = false;
Mathieu Giraud's avatar
Mathieu Giraud committed
322
  bool output_unsegmented = false;
323
  bool output_affects = false;
324
325
  bool keep_unsegmented_as_clone = false;

326
  bool multi_germline = false;
327
  bool multi_germline_incomplete = false;
328
  bool multi_germline_mark = false;
329
  bool multi_germline_one_index_per_germline = true;
330
  bool multi_germline_unexpected_recombinations = false;
331
  string multi_germline_file = DEFAULT_MULTIGERMLINE;
Mikaël Salson's avatar
Mikaël Salson committed
332
333
334

  string forced_edges = "" ;

335
  map <string, string> windows_labels ;
Mathieu Giraud's avatar
Mathieu Giraud committed
336
  string windows_labels_file = "" ;
337
  bool only_labeled_windows = false ;
Mikaël Salson's avatar
Mikaël Salson committed
338
339
340

  char c ;

341
342
  int options_s_k = 0 ;

343
344
  double expected_value = THRESHOLD_NB_EXPECTED;

WebTogz's avatar
WebTogz committed
345
346
347
  //JsonArray which contains the Levenshtein distances
  JsonArray jsonLevenshtein;

Mathieu Giraud's avatar
Mathieu Giraud committed
348
349
  //$$ options: getopt

350

351
  while ((c = getopt(argc, argv, "A!x:X:hHaiI12g:G:V:D:J:k:r:vw:e:C:f:W:l:Fc:m:M:N:s:b:Sn:o:L%:y:z:uUK3E:")) != EOF)
Mikaël Salson's avatar
Mikaël Salson committed
352
353
354
355

    switch (c)
      {
      case 'h':
356
357
358
359
        usage(argv[0], false);

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

Mikaël Salson's avatar
Mikaël Salson committed
361
      case 'c':
362
363
        if (!strcmp(COMMAND_CLONES,optarg))
          command = CMD_CLONES;
Mikaël Salson's avatar
Mikaël Salson committed
364
365
        else if (!strcmp(COMMAND_SEGMENT,optarg))
          command = CMD_SEGMENT;
Mathieu Giraud's avatar
Mathieu Giraud committed
366
367
        else if (!strcmp(COMMAND_WINDOWS,optarg))
          command = CMD_WINDOWS;
368
369
        else if (!strcmp(COMMAND_GERMLINES,optarg))
          command = CMD_GERMLINES;
Mikaël Salson's avatar
Mikaël Salson committed
370
371
        else {
          cerr << "Unknwown command " << optarg << endl;
372
	  usage(argv[0], false);
Mikaël Salson's avatar
Mikaël Salson committed
373
374
        }
        break;
375

Mikaël Salson's avatar
Mikaël Salson committed
376
377
378
379

      // Germline

      case 'V':
380
	f_reps_V.push_back(optarg);
381
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
382
383
384
	break;

      case 'D':
385
	f_reps_D.push_back(optarg);
386
387
	delta_min = DEFAULT_DELTA_MIN_D ;
	delta_max = DEFAULT_DELTA_MAX_D ;
Mikaël Salson's avatar
Mikaël Salson committed
388
389
390
	break;
        
      case 'J':
391
	f_reps_J.push_back(optarg);
392
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
393
394
	break;

395
      case 'g':
396
397
	multi_germline = true;
	multi_germline_file = string(optarg);
398
	germline_system = "multi" ;
399
	break;
400
401
402
403

      case 'i':
	multi_germline_incomplete = true;
	break;
404
405
406
407

      case 'I':
        multi_germline_mark = true;
	break;
408
409
410
411

      case '1':
        multi_germline_one_index_per_germline = false ;
        break;
412
413
414
415
416

      case '2':
        multi_germline_unexpected_recombinations = true ;
        break;

Mikaël Salson's avatar
Mikaël Salson committed
417
      case 'G':
Mikaël Salson's avatar
Mikaël Salson committed
418
	germline_system = string(optarg);
419
	f_reps_V.push_back((germline_system + "V.fa").c_str()) ;
420
421
422
423
424
        // 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)
425
426
427
428
429
            {
              f_reps_D.push_back(putative_f_rep_D.c_str()) ;
              delta_min = DEFAULT_DELTA_MIN_D ;
              delta_max = DEFAULT_DELTA_MAX_D ;
            }
430
        }
431
	f_reps_J.push_back((germline_system + "J.fa").c_str()) ;
432
	germline_system = extract_basename(germline_system);
433

Mikaël Salson's avatar
Mikaël Salson committed
434
435
436
437
	break;

      // Algorithm

438
439
440
441
442
443
444
445
446
447
      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
448
449
450
      case 'k':
	k = atoi(optarg);
	seed = seed_contiguous(k);
451
	options_s_k++ ;
Mikaël Salson's avatar
Mikaël Salson committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
        break;

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

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

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

466
467
468
469
      case '!':
        keep_unsegmented_as_clone = true;
        break;

470
      case 'e':
471
        expected_value = atof_NO_LIMIT(optarg);
472
473
        break;

474
475
      // Output 

Mikaël Salson's avatar
Mikaël Salson committed
476
477
478
479
      case 'o':
        out_dir = optarg ;
        break;

480
481
      case 'b':
        f_basename = optarg;
Mikaël Salson's avatar
Mikaël Salson committed
482
483
        break;

484
485
486
487
488
489
490
491
      case 'a':
	output_sequences_by_cluster = true;
	break;

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

492
493
      // Limits

Mikaël Salson's avatar
Mikaël Salson committed
494
495
496
497
      case '%':
	ratio_reads_clone = atof(optarg);
	break;

498
      case 'r':
Mikaël Salson's avatar
Mikaël Salson committed
499
500
501
	min_reads_clone = atoi(optarg);
        break;

502
      case 'y':
Mathieu Giraud's avatar
Mathieu Giraud committed
503
	max_representatives = atoi_NO_LIMIT(optarg);
504
505
        break;

Mikaël Salson's avatar
Mikaël Salson committed
506
      case 'z':
Mathieu Giraud's avatar
Mathieu Giraud committed
507
	max_clones = atoi_NO_LIMIT(optarg);
Mikaël Salson's avatar
Mikaël Salson committed
508
        break;
509
510
511

      case 'A': // --all
	ratio_reads_clone = 0 ;
512
513
514
	min_reads_clone = 1 ;
	max_representatives = -1 ;
	max_clones = -1 ;
515
516
	break ;

517
      case 'X':
518
519
520
521
        max_reads_processed_sample = atoi_NO_LIMIT(optarg);
        break;

      case 'x':
Mathieu Giraud's avatar
Mathieu Giraud committed
522
        max_reads_processed = atoi_NO_LIMIT(optarg);
523
        break;
524

525
526
527
528
529
530
      // Labels

      case 'W':
        windows_labels[string(optarg)] = '-W';
        break;

531
532
533
534
      case 'l':
	windows_labels_file = optarg; 
	break;

535
536
537
538
      case 'F':
        only_labeled_windows = true;
        break;

539
      // Clustering
540

541
      case 'E':
542
543
	forced_edges = optarg;
	break;
Mikaël Salson's avatar
Mikaël Salson committed
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
	
      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;
	
565
      // Fine segmentation
566
567
568
569
      case '3':
        detect_CDR3 = true;
        break;
        
570
      case 'f':
Mikaël Salson's avatar
Mikaël Salson committed
571
572
	segment_cost=strToCost(optarg, VDJ);
        break;
Mathieu Giraud's avatar
Mathieu Giraud committed
573
574
575
576

      case 'u':
        output_unsegmented = true;
        break;
577
578
579
      case 'U':
        output_segmented = true;
        break;
580
581
582
      case 'K':
        output_affects = true;
        break;
Mikaël Salson's avatar
Mikaël Salson committed
583
584
      }

585
586
587

  //$$ options: post-processing+display

588
589
590

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

595
596
  if (options_s_k > 1)
    {
597
      cerr << ERROR_STRING << "Use at most one -s or -k option." << endl ;
598
599
600
      exit(1);
    }

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

Mikaël Salson's avatar
Mikaël Salson committed
603
604
605
606
607
608
609
610
611
612
613
614
615
  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
    {
616
      cerr << ERROR_STRING << "Wrong number of arguments." << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
617
618
      exit(1);
    }
Mathieu Giraud's avatar
Mathieu Giraud committed
619

620
  size_t min_cover_representative = (size_t) (min_reads_clone < (int) max_auditionned ? min_reads_clone : max_auditionned) ;
621

622
623
624
625
626
627
  // Default seeds

#ifndef NO_SPACED_SEEDS
  if (k == DEFAULT_K)
    {
      if (germline_system.find("TRA") != string::npos)
628
	seed = SEED_S13 ;
629
630
631

      else if ((germline_system.find("TRB") != string::npos)
	       || (germline_system.find("IGH") != string::npos))
632
	seed = SEED_S12 ;
633
      else // TRD, TRG, IGK, IGL, custom, multi
634
	seed = SEED_S10 ;
635
636
637
638
639

      k = seed_weight(seed);
    }
#else
  {
640
    cerr << ERROR_STRING << "Vidjil was compiled with NO_SPACED_SEEDS: please provide a -k option." << endl;
641
642
643
644
645
    exit(1) ;
  }
#endif
	  

Mathieu Giraud's avatar
Mathieu Giraud committed
646
647
648
649
#ifndef NO_SPACED_SEEDS
  // Check seed buffer  
  if (seed.size() >= MAX_SEED_SIZE)
    {
650
      cerr << ERROR_STRING << "Seed size is too large (MAX_SEED_SIZE)." << endl ;
Mathieu Giraud's avatar
Mathieu Giraud committed
651
652
653
654
      exit(1);
    }
#endif

655
656
657

  if (w < seed_weight(seed))
    {
658
      cerr << ERROR_STRING << "Too small -w. The window size should be at least equal to the seed size (" << seed_weight(seed) << ")." << endl;
659
660
661
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
662
663
664
665
  // 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) {
666
    cerr << ERROR_STRING << "Directory creation: " << out_dir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
667
668
669
    exit(2);
  }

Mikaël Salson's avatar
Mikaël Salson committed
670
671
  const char *outseq_cstr = out_seqdir.c_str();
  if (mkpath(outseq_cstr, 0755) == -1) {
672
    cerr << ERROR_STRING << "Directory creation: " << out_seqdir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
673
674
675
    exit(2);
  }

676
677
678
679
680
  // 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
681
682
683
  out_dir += "/" ;

  /// Load labels ;
684
  load_into_map(windows_labels, windows_labels_file);
Mikaël Salson's avatar
Mikaël Salson committed
685
686

  switch(command) {
Mathieu Giraud's avatar
Mathieu Giraud committed
687
  case CMD_WINDOWS: cout << "Extracting windows" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
688
    break;
689
  case CMD_CLONES: cout << "Analysing clones" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
690
691
692
    break;
  case CMD_SEGMENT: cout << "Segmenting V(D)J" << endl;
    break;
693
694
  case CMD_GERMLINES: cout << "Discovering germlines" << endl;
    break;
Mikaël Salson's avatar
Mikaël Salson committed
695
696
  }

Mathieu Giraud's avatar
Mathieu Giraud committed
697
  cout << "Command line: ";
Mikaël Salson's avatar
Mikaël Salson committed
698
  for (int i=0; i < argc; i++) {
Mathieu Giraud's avatar
Mathieu Giraud committed
699
    cout << argv[i] << " ";
Mikaël Salson's avatar
Mikaël Salson committed
700
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
701
  cout << endl;
Mikaël Salson's avatar
Mikaël Salson committed
702
703
704
705
706
707
708
709
710
711
712
713

  //////////////////////////////////
  // 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
714
  cout << "# " << time_buffer << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
715
716
717
718
719


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

720
  string soft_version = "vidjil ";
Mikaël Salson's avatar
Mikaël Salson committed
721
#ifdef RELEASE_TAG
Mathieu Giraud's avatar
Mathieu Giraud committed
722
  cout << "# version: vidjil " << RELEASE_TAG << endl ;
723
  soft_version.append(RELEASE_TAG);
Mikaël Salson's avatar
Mikaël Salson committed
724
#else
725
726
727
  cout << "# development version" << endl ;
#ifdef GIT_VERSION
  cout << "# git: " << GIT_VERSION << endl ;
728
  soft_version.append("dev ");
729
  soft_version.append(GIT_VERSION);
730
#endif
731
#endif
732

733
734
  //////////////////////////////////
  // Warning for non-optimal use
735

736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
  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 ;
    }
757

758
759
760
  /////////////////////////////////////////
  //            LOAD GERMLINES           //
  /////////////////////////////////////////
761

762
763
764
765
766
767
768
  if (command == CMD_GERMLINES)
    {
      multi_germline = true ;
      multi_germline_one_index_per_germline = false ;
    }

  MultiGermline *multigermline = new MultiGermline(multi_germline_one_index_per_germline);
769

770
    {
771
      cout << "Load germlines and build Kmer indexes" << endl ;
772
773
774
775
776
777
778
779
780
781
    
      if (multi_germline)
	{
	  multigermline->build_default_set(multi_germline_file);
	}
      else
	{
	  // Custom germline
	  Germline *germline;
	  germline = new Germline(germline_system, 'X',
782
783
784
                                  f_reps_V, f_reps_D, f_reps_J, 
                                  delta_min, delta_max);

785
          germline->new_index(seed);
786

787
788
789
	  multigermline->insert(germline);
	}
    }
790

791
    cout << endl ;
792

793
    if (!multi_germline_one_index_per_germline) {
794
      multigermline->build_with_one_index(seed, true);
795
    }
796

797
      if (multi_germline_unexpected_recombinations) {
798
799
800
801
        if (!multigermline->index) {
          multigermline->build_with_one_index(seed, false);
        }

802
803
804
805
806
        Germline *pseudo = new Germline(PSEUDO_GERMLINE_MAX12, 'x', -10, 80);
        pseudo->index = multigermline->index ;
        multigermline->germlines.push_back(pseudo);
    }

807
808
809
810
811
812
      // Should come after the initialization of regular (and possibly pseudo) germlines
    if (multi_germline_incomplete) {
      multigermline->one_index_per_germline = true; // Starting from now, creates new indexes
      multigermline->build_incomplete_set(multi_germline_file);
    }

813
814
815
    if (multi_germline_mark)
      multigermline->mark_cross_germlines_as_ambiguous();
    
816
817
818
    cout << "Germlines loaded" << endl ;
    cout << *multigermline ;
    cout << endl ;
819
820
821
822

    // Number of reads for e-value computation
    int nb_reads_for_evalue = (expected_value > NO_LIMIT_VALUE) ? nb_sequences_in_fasta(f_reads, true) : 1 ;

823
    
824
825
826
827
828
829
830
  //////////////////////////////////
  //$$ Read sequence files
 
  OnlineFasta *reads;

  try {
    reads = new OnlineFasta(f_reads, 1, " ");
831
  } catch (const invalid_argument e) {
832
    cerr << ERROR_STRING << "Vidjil cannot open reads file " << f_reads << ": " << e.what() << endl;
833
834
835
836
837
838
    exit(1);
  }

  out_dir += "/";


839
840
841
842
843
  //////////////////////////////://////////
  //         DISCOVER GERMLINES          //
  /////////////////////////////////////////
  if (command == CMD_GERMLINES)
    {
844
      map <char, int> stats_kmer, stats_max;
845
      IKmerStore<KmerAffect> *index = multigermline->index ;
846
847

      // Initialize statistics, with two additional categories
848
849
      index->labels.push_back(make_pair(KmerAffect::getAmbiguous(), AFFECT_AMBIGUOUS_SYMBOL));
      index->labels.push_back(make_pair(KmerAffect::getUnknown(), AFFECT_UNKNOWN_SYMBOL));
850
851
      
      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
852
	{
853
854
855
	  char key = affect_char(it->first.affect) ;
	  stats_kmer[key] = 0 ;
	  stats_max[key] = 0 ;
856
857
	}
      
858
      // init forbidden for .max()
859
860
861
      set<KmerAffect> forbidden;
      forbidden.insert(KmerAffect::getAmbiguous());
      forbidden.insert(KmerAffect::getUnknown());
862
      
863
864
865
      // Loop through all reads

      int nb_reads = 0 ;
866
867
868
      int total_length = 0 ;
      int s = index->getS();

869
870
871
872
873
      while (reads->hasNext())
	{
	  reads->next();
	  nb_reads++;
	  string seq = reads->getSequence().sequence;
874
	  total_length += seq.length() - s + 1;
875

876
	  KmerAffectAnalyser *kaa = new KmerAffectAnalyser(*index, seq);
877
878
879

	  for (int i = 0; i < kaa->count(); i++) 
	    { 
880
881
	      KmerAffect ksa = kaa->getAffectation(i);
	      stats_kmer[affect_char(ksa.affect)]++ ;
882
	    }
883

884
          delete kaa;
885

886
	  CountKmerAffectAnalyser ckaa(*index, seq);
887
888
	  ckaa.setAllowedOverlap(k-1);

889
	  stats_max[affect_char(ckaa.max(forbidden).affect)]++ ;
890

891
892
	}

893
894
      delete reads;

895
896
      // Display statistics

897
898
899
900
      cout << "  <== "
	   << nb_reads << " reads, "
	   << total_length << " kmers"
	   << endl ;
901
      cout << "\t" << " max" << "\t\t" << "        kmers" << "\n" ;
902
903

      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
904
	{
905
906
907
908
	  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 << "%" ;
909

910
	  cout << "     " ;
911

912
913
	  cout << setw(12) << stats_kmer[key] << " " ;
	  cout << setw(6) << fixed << setprecision(2) <<  (float) stats_kmer[key] / total_length * 100 << "%" ;
914

915
	  cout << "     " << key << " " << it->second << endl ;
916
	}
917
918
      
      delete index;
919
920
921
922
      exit(0);
    }


Mikaël Salson's avatar
Mikaël Salson committed
923
924
925
  ////////////////////////////////////////
  //           CLONE ANALYSIS           //
  ////////////////////////////////////////
926
  if (command == CMD_CLONES || command == CMD_WINDOWS) {
Mikaël Salson's avatar
Mikaël Salson committed
927
928

    //////////////////////////////////
Mathieu Giraud's avatar
Mathieu Giraud committed
929
    //$$ Kmer Segmentation
Mikaël Salson's avatar
Mikaël Salson committed
930

931
932
933
934
935
936
937
938
    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
939
940
    cout << endl;
    cout << "Loop through reads, looking for windows" << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
941

942
    ofstream *out_segmented = NULL;
Mathieu Giraud's avatar
Mathieu Giraud committed
943
    ofstream *out_unsegmented = NULL;
944
    ofstream *out_affects = NULL;
Mikaël Salson's avatar
Mikaël Salson committed
945
 
Mathieu Giraud's avatar
Mathieu Giraud committed
946
    WindowExtractor we;
947
948
    if (! output_sequences_by_cluster)
      we.setMaximalNbReadsPerWindow(max_auditionned);
949
950
 
    if (output_segmented) {
951
      string f_segmented = out_dir + f_basename + SEGMENTED_FILENAME ;
952
953
954
955
956
      cout << "  ==> " << f_segmented << endl ;
      out_segmented = new ofstream(f_segmented.c_str());
      we.setSegmentedOutput(out_segmented);
    }

Mathieu Giraud's avatar
Mathieu Giraud committed
957
    if (output_unsegmented) {
958
      string f_unsegmented = out_dir + f_basename + UNSEGMENTED_FILENAME ;
Mathieu Giraud's avatar
Mathieu Giraud committed
959
960
961
962
      cout << "  ==> " << f_unsegmented << endl ;
      out_unsegmented = new ofstream(f_unsegmented.c_str());
      we.setUnsegmentedOutput(out_unsegmented);
    }
963

964
965
966
967
968
969
970
    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);
    }