vidjil.cpp 48.2 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

Mikaël Salson's avatar
Mikaël Salson committed
119 120
#define DEFAULT_TRIM 100

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

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

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

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

using namespace std ;

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

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

extern int optind, optopt, opterr;

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

  cerr << "Command selection" << endl
146 147 148 149 150
       << "  -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
151 152
       << endl       

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

162 163
  if (advanced)
  cerr << "Experimental options (do not use)" << endl
164
       << "  -I            ignore k-mers common to different germline systems (experimental, must be used with -g, do not use)" << endl
165
       << "  -1            use a unique index for all germline systems (experimental, must be used with -g, do not use)" << endl
166
       << "  -2            try to detect unexpected recombinations (experimental, must be used with -g, do not use)" << endl
167
       << "  -!            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
168 169
       << endl

Mathieu Giraud's avatar
Mathieu Giraud committed
170
       << "Window prediction" << endl
Mikaël Salson's avatar
Mikaël Salson committed
171
#ifndef NO_SPACED_SEEDS
172
       << "  (use either -s or -k option, but not both)" << endl
173
       << "  (all these options, except -w, are overriden when using -g)" << endl
174 175
       << "  -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
176
#endif
177
       << "  -k <int>      k-mer size used for the V/J affectation (default: 10, 12, 13, depends on germline)" << endl
178 179 180
#ifndef NO_SPACED_SEEDS
       << "                (using -k option is equivalent to set with -s a contiguous seed with only '#' characters)" << endl
#endif
181 182
       << "  -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
183
       << "  -w <int>      w-mer size used for the length of the extracted window (default: " << DEFAULT_W << ")" << endl
184
       << "  -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
185
       << "  -t <int>      trim V and J genes (resp. 5' and 3' regions) to keep at most <int> nt (default: " << DEFAULT_TRIM << ")" << endl
Mikaël Salson's avatar
Mikaël Salson committed
186 187
       << endl

188 189 190
       << "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
191
       << "  -F            filter -- keep only the labeled windows" << endl
192
       << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
193

194
  cerr << "Limits to report a clone (or a window)" << endl
195 196
       << "  -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
197 198
       << endl

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

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

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

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

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

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

Mathieu Giraud's avatar
Mathieu Giraud committed
252 253 254

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

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

Mathieu Giraud's avatar
Mathieu Giraud committed
276 277
  //$$ options: defaults

278
  string germline_system = "" ;
279 280 281 282 283
  
  list <string> f_reps_V ;
  list <string> f_reps_D ;
  list <string> f_reps_J ;

Mikaël Salson's avatar
Mikaël Salson committed
284 285
  string f_reads = DEFAULT_READS ;
  string seed = DEFAULT_SEED ;
286
  string f_basename = "";
Mikaël Salson's avatar
Mikaël Salson committed
287

288
  string out_dir = DEFAULT_OUT_DIR;
Mikaël Salson's avatar
Mikaël Salson committed
289 290 291 292
  
  string comp_filename = COMP_FILENAME;

  int k = DEFAULT_K ;
293
  int w = DEFAULT_W ;
Mikaël Salson's avatar
Mikaël Salson committed
294

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

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

313
  int max_reads_processed = -1;
314
  int max_reads_processed_sample = -1;
315

Mathieu Giraud's avatar
Mathieu Giraud committed
316
  float ratio_representative = DEFAULT_RATIO_REPRESENTATIVE;
Mikaël Salson's avatar
Mikaël Salson committed
317
  unsigned int max_auditionned = DEFAULT_MAX_AUDITIONED;
Mathieu Giraud's avatar
Mathieu Giraud committed
318

Mikaël Salson's avatar
Mikaël Salson committed
319 320 321
  // Admissible delta between left and right segmentation points
  int delta_min = DEFAULT_DELTA_MIN ; // Kmer+Fine
  int delta_max = DEFAULT_DELTA_MAX ; // Fine
Mikaël Salson's avatar
Mikaël Salson committed
322
  int trim_sequences = DEFAULT_TRIM;
Mikaël Salson's avatar
Mikaël Salson committed
323 324

  bool output_sequences_by_cluster = false;
325
  bool output_segmented = false;
Mathieu Giraud's avatar
Mathieu Giraud committed
326
  bool output_unsegmented = false;
327
  bool output_affects = false;
328 329
  bool keep_unsegmented_as_clone = false;

330
  bool multi_germline = false;
331
  bool multi_germline_incomplete = false;
332
  bool multi_germline_mark = false;
333
  bool multi_germline_one_index_per_germline = true;
334
  bool multi_germline_unexpected_recombinations = false;
335
  string multi_germline_file = DEFAULT_MULTIGERMLINE;
Mikaël Salson's avatar
Mikaël Salson committed
336 337 338

  string forced_edges = "" ;

339
  map <string, string> windows_labels ;
Mathieu Giraud's avatar
Mathieu Giraud committed
340
  string windows_labels_file = "" ;
341
  bool only_labeled_windows = false ;
Mikaël Salson's avatar
Mikaël Salson committed
342 343 344

  char c ;

345 346
  int options_s_k = 0 ;

347 348
  double expected_value = THRESHOLD_NB_EXPECTED;

WebTogz's avatar
WebTogz committed
349 350 351
  //JsonArray which contains the Levenshtein distances
  JsonArray jsonLevenshtein;

Mathieu Giraud's avatar
Mathieu Giraud committed
352 353
  //$$ options: getopt

354

Mikaël Salson's avatar
Mikaël Salson committed
355
  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:t:")) != EOF)
Mikaël Salson's avatar
Mikaël Salson committed
356 357 358 359

    switch (c)
      {
      case 'h':
360 361 362 363
        usage(argv[0], false);

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

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

Mikaël Salson's avatar
Mikaël Salson committed
380 381 382 383

      // Germline

      case 'V':
384
	f_reps_V.push_back(optarg);
385
	germline_system = "custom" ;
Mikaël Salson's avatar
Mikaël Salson committed
386 387 388
	break;

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

399
      case 'g':
400 401
	multi_germline = true;
	multi_germline_file = string(optarg);
402
	germline_system = "multi" ;
403
	break;
404 405 406 407

      case 'i':
	multi_germline_incomplete = true;
	break;
408 409 410 411

      case 'I':
        multi_germline_mark = true;
	break;
412 413 414 415

      case '1':
        multi_germline_one_index_per_germline = false ;
        break;
416 417 418 419 420

      case '2':
        multi_germline_unexpected_recombinations = true ;
        break;

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

Mikaël Salson's avatar
Mikaël Salson committed
438 439 440 441
	break;

      // Algorithm

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

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

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

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

470 471 472 473
      case '!':
        keep_unsegmented_as_clone = true;
        break;

474
      case 'e':
475
        expected_value = atof_NO_LIMIT(optarg);
476 477
        break;

478 479
      // Output 

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

484 485
      case 'b':
        f_basename = optarg;
Mikaël Salson's avatar
Mikaël Salson committed
486 487
        break;

488 489 490 491
      case 'a':
	output_sequences_by_cluster = true;
	break;

Mikaël Salson's avatar
Mikaël Salson committed
492 493 494 495
      case 't':
        trim_sequences = atoi(optarg);
        break;

496 497 498 499
      case 'v':
	verbose += 1 ;
	break;

500 501
      // Limits

Mikaël Salson's avatar
Mikaël Salson committed
502 503 504 505
      case '%':
	ratio_reads_clone = atof(optarg);
	break;

506
      case 'r':
Mikaël Salson's avatar
Mikaël Salson committed
507 508 509
	min_reads_clone = atoi(optarg);
        break;

510
      case 'y':
Mathieu Giraud's avatar
Mathieu Giraud committed
511
	max_representatives = atoi_NO_LIMIT(optarg);
512 513
        break;

Mikaël Salson's avatar
Mikaël Salson committed
514
      case 'z':
Mathieu Giraud's avatar
Mathieu Giraud committed
515
	max_clones = atoi_NO_LIMIT(optarg);
Mikaël Salson's avatar
Mikaël Salson committed
516
        break;
517 518 519

      case 'A': // --all
	ratio_reads_clone = 0 ;
520 521 522
	min_reads_clone = 1 ;
	max_representatives = -1 ;
	max_clones = -1 ;
523 524
	break ;

525
      case 'X':
526 527 528 529
        max_reads_processed_sample = atoi_NO_LIMIT(optarg);
        break;

      case 'x':
Mathieu Giraud's avatar
Mathieu Giraud committed
530
        max_reads_processed = atoi_NO_LIMIT(optarg);
531
        break;
532

533 534 535
      // Labels

      case 'W':
Mathieu Giraud's avatar
Mathieu Giraud committed
536
        windows_labels[string(optarg)] = string("-W");
537 538
        break;

539 540 541 542
      case 'l':
	windows_labels_file = optarg; 
	break;

543 544 545 546
      case 'F':
        only_labeled_windows = true;
        break;

547
      // Clustering
548

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

      case 'u':
        output_unsegmented = true;
        break;
585 586 587
      case 'U':
        output_segmented = true;
        break;
588 589 590
      case 'K':
        output_affects = true;
        break;
Mikaël Salson's avatar
Mikaël Salson committed
591 592
      }

593 594 595

  //$$ options: post-processing+display

596 597 598

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

603 604
  if (options_s_k > 1)
    {
605
      cerr << ERROR_STRING << "Use at most one -s or -k option." << endl ;
606 607 608
      exit(1);
    }

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

Mikaël Salson's avatar
Mikaël Salson committed
611 612 613 614 615 616 617 618 619 620 621 622 623
  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
    {
624
      cerr << ERROR_STRING << "Wrong number of arguments." << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
625 626
      exit(1);
    }
Mathieu Giraud's avatar
Mathieu Giraud committed
627

628
  size_t min_cover_representative = (size_t) (min_reads_clone < (int) max_auditionned ? min_reads_clone : max_auditionned) ;
629

630 631 632 633 634 635
  // Default seeds

#ifndef NO_SPACED_SEEDS
  if (k == DEFAULT_K)
    {
      if (germline_system.find("TRA") != string::npos)
636
	seed = SEED_S13 ;
637 638 639

      else if ((germline_system.find("TRB") != string::npos)
	       || (germline_system.find("IGH") != string::npos))
640
	seed = SEED_S12 ;
641
      else // TRD, TRG, IGK, IGL, custom, multi
642
	seed = SEED_S10 ;
643 644 645 646 647

      k = seed_weight(seed);
    }
#else
  {
648
    cerr << ERROR_STRING << "Vidjil was compiled with NO_SPACED_SEEDS: please provide a -k option." << endl;
649 650 651 652 653
    exit(1) ;
  }
#endif
	  

Mathieu Giraud's avatar
Mathieu Giraud committed
654 655 656 657
#ifndef NO_SPACED_SEEDS
  // Check seed buffer  
  if (seed.size() >= MAX_SEED_SIZE)
    {
658
      cerr << ERROR_STRING << "Seed size is too large (MAX_SEED_SIZE)." << endl ;
Mathieu Giraud's avatar
Mathieu Giraud committed
659 660 661 662
      exit(1);
    }
#endif

663 664 665

  if (w < seed_weight(seed))
    {
666
      cerr << ERROR_STRING << "Too small -w. The window size should be at least equal to the seed size (" << seed_weight(seed) << ")." << endl;
667 668 669
      exit(1);
    }

Mikaël Salson's avatar
Mikaël Salson committed
670 671 672 673
  // 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) {
674
    cerr << ERROR_STRING << "Directory creation: " << out_dir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
675 676 677
    exit(2);
  }

Mikaël Salson's avatar
Mikaël Salson committed
678 679
  const char *outseq_cstr = out_seqdir.c_str();
  if (mkpath(outseq_cstr, 0755) == -1) {
680
    cerr << ERROR_STRING << "Directory creation: " << out_seqdir << endl; perror("");
Mikaël Salson's avatar
Mikaël Salson committed
681 682 683
    exit(2);
  }

684 685 686 687 688
  // 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
689 690 691
  out_dir += "/" ;

  /// Load labels ;
692
  load_into_map(windows_labels, windows_labels_file);
Mikaël Salson's avatar
Mikaël Salson committed
693 694

  switch(command) {
Mathieu Giraud's avatar
Mathieu Giraud committed
695
  case CMD_WINDOWS: cout << "Extracting windows" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
696
    break;
697
  case CMD_CLONES: cout << "Analysing clones" << endl; 
Mikaël Salson's avatar
Mikaël Salson committed
698 699 700
    break;
  case CMD_SEGMENT: cout << "Segmenting V(D)J" << endl;
    break;
701 702
  case CMD_GERMLINES: cout << "Discovering germlines" << endl;
    break;
Mikaël Salson's avatar
Mikaël Salson committed
703 704
  }

Mathieu Giraud's avatar
Mathieu Giraud committed
705
  cout << "Command line: ";
Mikaël Salson's avatar
Mikaël Salson committed
706
  for (int i=0; i < argc; i++) {
Mathieu Giraud's avatar
Mathieu Giraud committed
707
    cout << argv[i] << " ";
Mikaël Salson's avatar
Mikaël Salson committed
708
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
709
  cout << endl;
Mikaël Salson's avatar
Mikaël Salson committed
710 711 712 713 714 715 716 717 718 719 720 721

  //////////////////////////////////
  // 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
722
  cout << "# " << time_buffer << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
723 724 725 726 727


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

728
  string soft_version = "vidjil ";
Mikaël Salson's avatar
Mikaël Salson committed
729
#ifdef RELEASE_TAG
Mathieu Giraud's avatar
Mathieu Giraud committed
730
  cout << "# version: vidjil " << RELEASE_TAG << endl ;
731
  soft_version.append(RELEASE_TAG);
Mikaël Salson's avatar
Mikaël Salson committed
732
#else
733 734 735
  cout << "# development version" << endl ;
#ifdef GIT_VERSION
  cout << "# git: " << GIT_VERSION << endl ;
736
  soft_version.append("dev ");
737
  soft_version.append(GIT_VERSION);
738
#endif
739
#endif
740

741 742
  //////////////////////////////////
  // Warning for non-optimal use
743

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
  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 ;
    }
765

766 767 768
  /////////////////////////////////////////
  //            LOAD GERMLINES           //
  /////////////////////////////////////////
769

770 771 772 773 774 775 776
  if (command == CMD_GERMLINES)
    {
      multi_germline = true ;
      multi_germline_one_index_per_germline = false ;
    }

  MultiGermline *multigermline = new MultiGermline(multi_germline_one_index_per_germline);
777

778
    {
779
      cout << "Load germlines and build Kmer indexes" << endl ;
780 781 782
    
      if (multi_germline)
	{
Mikaël Salson's avatar
Mikaël Salson committed
783
	  multigermline->build_default_set(multi_germline_file, trim_sequences);
784 785 786 787 788 789
	}
      else
	{
	  // Custom germline
	  Germline *germline;
	  germline = new Germline(germline_system, 'X',
790
                                  f_reps_V, f_reps_D, f_reps_J, 
Mikaël Salson's avatar
Mikaël Salson committed
791
                                  delta_min, delta_max, trim_sequences);
792

793
          germline->new_index(seed);
794

795 796 797
	  multigermline->insert(germline);
	}
    }
798

799
    cout << endl ;
800

801
    if (!multi_germline_one_index_per_germline) {
802
      multigermline->build_with_one_index(seed, true);
803
    }
804

805
      if (multi_germline_unexpected_recombinations) {
806 807 808 809
        if (!multigermline->index) {
          multigermline->build_with_one_index(seed, false);
        }

Mikaël Salson's avatar
Mikaël Salson committed
810
        Germline *pseudo = new Germline(PSEUDO_GERMLINE_MAX12, 'x', -10, 80, trim_sequences);
811 812 813 814
        pseudo->index = multigermline->index ;
        multigermline->germlines.push_back(pseudo);
    }

815 816 817
      // 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
Mikaël Salson's avatar
Mikaël Salson committed
818
      multigermline->build_incomplete_set(multi_germline_file, trim_sequences);
819 820
    }

821 822 823
    if (multi_germline_mark)
      multigermline->mark_cross_germlines_as_ambiguous();
    
824 825 826
    cout << "Germlines loaded" << endl ;
    cout << *multigermline ;
    cout << endl ;
827 828 829 830

    // 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 ;

831
    
832 833 834 835 836 837 838
  //////////////////////////////////
  //$$ Read sequence files
 
  OnlineFasta *reads;

  try {
    reads = new OnlineFasta(f_reads, 1, " ");
839
  } catch (const invalid_argument e) {
840
    cerr << ERROR_STRING << "Vidjil cannot open reads file " << f_reads << ": " << e.what() << endl;
841 842 843 844 845 846
    exit(1);
  }

  out_dir += "/";


847 848 849 850 851
  //////////////////////////////://////////
  //         DISCOVER GERMLINES          //
  /////////////////////////////////////////
  if (command == CMD_GERMLINES)
    {
852
      map <char, int> stats_kmer, stats_max;
853
      IKmerStore<KmerAffect> *index = multigermline->index ;
854 855

      // Initialize statistics, with two additional categories
856 857
      index->labels.push_back(make_pair(KmerAffect::getAmbiguous(), AFFECT_AMBIGUOUS_SYMBOL));
      index->labels.push_back(make_pair(KmerAffect::getUnknown(), AFFECT_UNKNOWN_SYMBOL));
858 859
      
      for (list< pair <KmerAffect, string> >::const_iterator it = index->labels.begin(); it != index->labels.end(); ++it)
860
	{