fasta.cpp 9.77 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 24 25 26 27 28 29 30 31

  "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/>
*/

#include <fstream>
#include <iostream>
#include <iomanip>
#include <algorithm>
#include <cctype>
#include <stdexcept>
#include "fasta.h"

32
#include "../lib/gzstream.h"
33

34 35 36 37 38 39 40 41

// http://stackoverflow.com/a/5840160/4475279
unsigned long long filesize(const char* filename)
{
    std::ifstream in(filename, std::ifstream::ate | std::ifstream::binary);
    return in.tellg();
}

42 43 44 45 46
void Fasta::init(int extract_field, string extract_separator)
{
  this -> extract_field = extract_field ;
  this -> extract_separator = extract_separator ; 
  total_size = 0;
47 48 49 50 51 52 53
  name = "";
}

Fasta::Fasta(bool virtualfasta, string name)
{
  init(0, "");
  this -> name = name;
54 55 56 57 58
}

Fasta::Fasta(int extract_field, string extract_separator)
{
  init(extract_field, extract_separator);
Mikaël Salson's avatar
Mikaël Salson committed
59 60 61
}

Fasta::Fasta(const string &input, 
62 63
	     int extract_field, string extract_separator,
             bool verbose) 
Mikaël Salson's avatar
Mikaël Salson committed
64
{
65 66
  init(extract_field, extract_separator);

67
  if (!input.size()) // Do not open empty filenames (D germline if not segmentD)
Mikaël Salson's avatar
Mikaël Salson committed
68 69
    return ;

70
  add(input, verbose);  
71 72
}

73
void Fasta::add(istream &in, bool verbose) {
74
  in >> *this;
75

76
  if (verbose)
77
  cout << "\t" << setw(6) << total_size << " bp in " << setw(3) << size() << " sequences" << endl ;
78 79
}

80
void Fasta::add(const string &filename, bool verbose) {
81
  igzstream is(filename.c_str());
Mikaël Salson's avatar
Mikaël Salson committed
82 83
  if (is.fail())
    {
84
      throw invalid_argument(" !! Error in opening file: "+ filename);
Mikaël Salson's avatar
Mikaël Salson committed
85
    }
86

87 88
  name += filename + " ";

89
  if (verbose)
90
  cout << " <== " << filename ;
91
  add(is, verbose);
Mikaël Salson's avatar
Mikaël Salson committed
92 93 94
  is.close();
}

95 96 97 98 99
void Fasta::add(Sequence seq) {
  reads.push_back(seq);
  total_size += seq.sequence.size();
}

Mikaël Salson's avatar
Mikaël Salson committed
100
int Fasta::size() const{ return (int)reads.size(); }
101 102
int Fasta::totalSize() const { return total_size ; }

Mathieu Giraud's avatar
Mathieu Giraud committed
103 104 105 106 107 108 109 110 111
list<Sequence> Fasta::getAll() const {
  list<Sequence> reads;

  for (int i=0; i < size(); i++) {
    reads.push_back(read(i));
  }

  return reads;
}
Mikaël Salson's avatar
Mikaël Salson committed
112 113 114 115 116 117 118
const string& Fasta::label(int index) const{ return reads[index].label; }
const string& Fasta::label_full(int index) const{ return reads[index].label_full; }
const Sequence& Fasta::read(int index) const {return reads[index];}
const string& Fasta::sequence(int index) const{ return reads[index].sequence; }

// OnlineFasta

119 120 121 122 123
OnlineFasta::OnlineFasta(int extract_field, string extract_separator,
                         int nb_sequences_max, int only_nth_sequence):
  input(NULL),
  extract_field(extract_field), extract_separator(extract_separator),
  nb_sequences_max(nb_sequences_max), only_nth_sequence(only_nth_sequence){}
Mikaël Salson's avatar
Mikaël Salson committed
124 125

OnlineFasta::OnlineFasta(const string &input, 
126 127
                         int extract_field, string extract_separator,
                         int nb_sequences_max, int only_nth_sequence)
128
  :input(new igzstream(input.c_str())),
Mikaël Salson's avatar
Mikaël Salson committed
129
  extract_field(extract_field), 
130 131
   extract_separator(extract_separator),
   nb_sequences_max(nb_sequences_max), only_nth_sequence(only_nth_sequence)
Mikaël Salson's avatar
Mikaël Salson committed
132 133
{
  if (this->input->fail()) {
134
    delete this->input;
135
    throw invalid_argument("!! Error in opening file "+input);
Mikaël Salson's avatar
Mikaël Salson committed
136
  }
Mathieu Giraud's avatar
Mathieu Giraud committed
137 138

  cout << "  <== " << input << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
139 140 141 142 143
  input_allocated = true;
  init();
}

OnlineFasta::OnlineFasta(istream &input, 
144 145
                         int extract_field, string extract_separator,
                         int nb_sequences_max, int only_nth_sequence)
146
  :input(&input), extract_field(extract_field),
147 148
   extract_separator(extract_separator),
   nb_sequences_max(nb_sequences_max), only_nth_sequence(only_nth_sequence)
Mikaël Salson's avatar
Mikaël Salson committed
149 150 151 152 153 154 155 156
{
  input_allocated = false;
  init();
}

OnlineFasta::~OnlineFasta() {
  if (input_allocated)
    delete input;
157 158
  if (current.seq)
    delete [] current.seq;
Mikaël Salson's avatar
Mikaël Salson committed
159 160 161
}

void OnlineFasta::init() {
162
  nb_sequences_parsed = 0;
163
  nb_sequences_returned = 0;
164
  char_nb = 0;
Mikaël Salson's avatar
Mikaël Salson committed
165 166
  line_nb = 0;
  line = getInterestingLine();
167
  current.seq = NULL;
Mikaël Salson's avatar
Mikaël Salson committed
168 169
}

170 171 172 173
unsigned long long OnlineFasta::getPos() {
  return char_nb;
}

Mikaël Salson's avatar
Mikaël Salson committed
174 175 176 177 178 179 180 181
size_t OnlineFasta::getLineNb() {
  return line_nb;
}

Sequence OnlineFasta::getSequence() {
  return current;
}

182 183 184 185 186

bool OnlineFasta::hasNextData() {
  return ((!input->eof()) || line.length() > 0);
}

Mikaël Salson's avatar
Mikaël Salson committed
187
bool OnlineFasta::hasNext() {
188
  return hasNextData()
189
    && ((nb_sequences_max == NO_LIMIT_VALUE) || (nb_sequences_returned < nb_sequences_max));
Mikaël Salson's avatar
Mikaël Salson committed
190 191
}

192 193
void OnlineFasta::skipToNthSequence() {
  // Possibly skip some reads, when only_nth_sequence > 1
194
  while (hasNextData())
195 196 197 198 199 200 201 202 203 204 205
    if (nb_sequences_parsed % only_nth_sequence)
      {
        nb_sequences_returned--;
        next();
        continue ;
      }
    else
      return  ;
}


Mikaël Salson's avatar
Mikaël Salson committed
206 207 208 209 210 211 212 213
void OnlineFasta::next() {
  fasta_state state = FASTX_UNINIT;

  // Reinit the Sequence object
  current.label_full.erase();
  current.label.erase();
  current.sequence.erase();
  current.quality.erase();
214
  if (current.seq) {
215
    delete [] current.seq;
216 217
    current.seq = NULL;
  }
Mikaël Salson's avatar
Mikaël Salson committed
218

219
  if  (hasNextData()) {
Mikaël Salson's avatar
Mikaël Salson committed
220 221 222 223
    switch(line[0]) {
    case '>': state=FASTX_FASTA; break;
    case '@': state=FASTX_FASTQ_ID; break;
    default: 
224
      throw invalid_argument("The file seems to be malformed!");
Mikaël Salson's avatar
Mikaël Salson committed
225 226 227
    }
    
    // Identifier line
228
    nb_sequences_parsed++;
229
    nb_sequences_returned++;
Mikaël Salson's avatar
Mikaël Salson committed
230 231 232 233
    current.label_full = line.substr(1);
    current.label = extract_from_label(current.label_full, extract_field, extract_separator);

    line = getInterestingLine();
234
    while (hasNextData() && ((state != FASTX_FASTA || line[0] != '>')
Mikaël Salson's avatar
Mikaël Salson committed
235 236
                         && (state != FASTX_FASTQ_QUAL || line[0] != '@'))) {

237
      if (hasNextData()) {
Mikaël Salson's avatar
Mikaël Salson committed
238 239 240 241 242 243 244
        switch(state) {
        case FASTX_FASTA: case FASTX_FASTQ_ID:
          // Sequence
          current.sequence += line;
          break;
        case FASTX_FASTQ_SEQ:
          // FASTQ separator between sequence and quality
245 246
          if (line[0] != '+')
            throw invalid_argument("Expected line starting with + in FASTQ file");
Mikaël Salson's avatar
Mikaël Salson committed
247 248 249 250
          break;
        case FASTX_FASTQ_SEP:
          // Reading quality
          current.quality = line;
251 252
          if (current.quality.length() != current.sequence.length())
            throw invalid_argument("Quality and sequence don't have the same length ");
Mikaël Salson's avatar
Mikaël Salson committed
253 254
          break;
        default:
255
          throw invalid_argument("Unexpected state after reading identifiers line");
Mikaël Salson's avatar
Mikaël Salson committed
256 257 258 259 260 261
        }
        if (state >= FASTX_FASTQ_ID && state <= FASTX_FASTQ_SEP)
          state = (fasta_state)(((int)state) + 1);
      } else {
        unexpectedEOF();
      }
262
      line = getInterestingLine(state);
Mikaël Salson's avatar
Mikaël Salson committed
263 264 265 266 267 268 269
    }

    if (state >= FASTX_FASTQ_ID && state < FASTX_FASTQ_QUAL) 
      unexpectedEOF();

    // Sequence in uppercase
    transform(current.sequence.begin(), current.sequence.end(), current.sequence.begin(), (int (*)(int))toupper);
270 271 272

    // Compute seq
    current.seq = new int[current.sequence.length()];
273
    for (unsigned int i=0; i< current.sequence.length(); i++)
274
      {
275
	current.seq[i] = nuc_to_int(current.sequence[i]) ;
276 277
      }

Mikaël Salson's avatar
Mikaël Salson committed
278 279
  } else
    unexpectedEOF();
280 281

  skipToNthSequence();
Mikaël Salson's avatar
Mikaël Salson committed
282 283
}

284
string OnlineFasta::getInterestingLine(int state) {
Mikaël Salson's avatar
Mikaël Salson committed
285
  string line;
286
  while (line.length() == 0 && hasNextData() && getline(*input, line)) {
Mikaël Salson's avatar
Mikaël Salson committed
287
    line_nb++;
288
    char_nb += line.length() + 1;
Mikaël Salson's avatar
Mikaël Salson committed
289
    remove_trailing_whitespaces(line);
290 291 292

    if (line.length() && line[0] == '#' && state != FASTX_FASTQ_SEP)
      line = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
293 294 295 296 297
  }
  return line;
}

void OnlineFasta::unexpectedEOF() {
298
  throw invalid_argument("Unexpected EOF while reading FASTA/FASTQ file");
Mikaël Salson's avatar
Mikaël Salson committed
299 300 301 302 303 304 305 306 307 308 309
}

// Operators

istream& operator>>(istream& in, Fasta& fasta){
	string line;
	Sequence read;
        OnlineFasta of(in, fasta.extract_field, fasta.extract_separator);

        while (of.hasNext()) {
          of.next();
310
          fasta.add(of.getSequence());
Mikaël Salson's avatar
Mikaël Salson committed
311 312 313 314 315 316
        }
	return in;
}

ostream& operator<<(ostream& out, Fasta& fasta){
	for(int i = 0 ; i < fasta.size() ; i++){
317
          out << fasta.read(i);
Mikaël Salson's avatar
Mikaël Salson committed
318 319 320 321 322
	}
	return out;
}

ostream &operator<<(ostream &out, const Sequence &seq) {
323 324 325 326 327 328 329
  bool is_fastq=false;
  if (seq.quality.length() > 0) {
    is_fastq = true;
    out << "@";
  } else
    out << ">";
  out << seq.label << endl;
Mikaël Salson's avatar
Mikaël Salson committed
330
  out << seq.sequence << endl;
331 332 333
  if (is_fastq) {
    out << "+" << endl << seq.quality << endl;
  }
Mikaël Salson's avatar
Mikaël Salson committed
334 335
  return out;
}
336

337
int nb_sequences_in_fasta(string f, bool approx)
338
{
339 340 341
  if (approx)
    return approx_nb_sequences_in_fasta(f);

342 343 344 345 346 347 348 349 350 351
  OnlineFasta *sequences = new OnlineFasta(f, 1, " ");
  int nb_sequences = 0 ;

  while (sequences->hasNext())
    {
      sequences->next();
      nb_sequences++ ;
    }

  cout << "  ==> " << nb_sequences << " sequences" << endl;
352 353

  delete sequences ;
354 355
  return nb_sequences ;
}
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381


#define SAMPLE_APPROX_NB_SEQUENCES 200

int approx_nb_sequences_in_fasta(string f)
{
  OnlineFasta *sequences = new OnlineFasta(f, 1, " ");
  int nb_sequences = 0 ;

  while (nb_sequences < SAMPLE_APPROX_NB_SEQUENCES && sequences->hasNext())
    {
      sequences->next();
      nb_sequences++ ;
    }

  cout << "  ==> " ;

  if (sequences->hasNext())
    {
      cout << "approx. " ;
      float ratio = (float) filesize(f.c_str()) / (float) sequences->getPos();
      nb_sequences = (int) (ratio * nb_sequences);
    }

  cout << nb_sequences << " sequences" << endl;

382
  delete sequences ;
383 384
  return nb_sequences ;
}