1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 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 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# kate: word-wrap off; remove-trailing-spaces all;
#
# Copyright (c) 2010-2016 Marcel Martin <marcel.martin@scilifelab.se>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
cutadapt version %version
Copyright (C) 2010-2016 Marcel Martin <marcel.martin@scilifelab.se>
cutadapt removes adapter sequences from high-throughput sequencing reads.
Usage:
cutadapt -a ADAPTER [options] [-o output.fastq] input.fastq
For paired-end reads:
cutadapt -a ADAPT1 -A ADAPT2 [options] -o out1.fastq -p out2.fastq in1.fastq in2.fastq
Replace "ADAPTER" with the actual sequence of your 3' adapter. IUPAC wildcard
characters are supported. The reverse complement is *not* automatically
searched. All reads from input.fastq will be written to output.fastq with the
adapter sequence removed. Adapter matching is error-tolerant. Multiple adapter
sequences can be given (use further -a options), but only the best-matching
adapter will be removed.
Input may also be in FASTA format. Compressed input and output is supported and
auto-detected from the file name (.gz, .xz, .bz2). Use the file name '-' for
standard input/output. Without the -o option, output is sent to standard output.
Citation:
Marcel Martin. Cutadapt removes adapter sequences from high-throughput
sequencing reads. EMBnet.Journal, 17(1):10-12, May 2011.
http://dx.doi.org/10.14806/ej.17.1.200
Use "cutadapt --help" to see all command-line options.
See http://cutadapt.readthedocs.org/ for full documentation.
"""
from __future__ import print_function, division, absolute_import
# Print a helpful error message if the extension modules cannot be imported.
from cutadapt import check_importability
check_importability()
import sys
import time
import errno
from optparse import OptionParser, OptionGroup, SUPPRESS_HELP
import functools
import logging
import platform
import textwrap
from xopen import xopen
from cutadapt import seqio, __version__
from cutadapt.adapters import AdapterParser
from cutadapt.modifiers import (LengthTagModifier, SuffixRemover, PrefixSuffixAdder,
DoubleEncoder, ZeroCapper, PrimerTrimmer, QualityTrimmer, UnconditionalCutter,
NEndTrimmer, AdapterCutter, NextseqQualityTrimmer, Shortener)
from cutadapt.filters import (NoFilter, PairedNoFilter, Redirector, PairedRedirector,
LegacyPairedRedirector, TooShortReadFilter, TooLongReadFilter,
Demultiplexer, NContentFilter, DiscardUntrimmedFilter, DiscardTrimmedFilter)
from cutadapt.report import Statistics, print_report, redirect_standard_output
from cutadapt.compat import next
logger = logging.getLogger()
class CutadaptOptionParser(OptionParser):
def get_usage(self):
return self.usage.lstrip().replace('%version', __version__)
class RestFileWriter(object):
def __init__(self, file):
self.file = file
def write(self, match):
rest = match.rest()
if len(rest) > 0:
print(rest, match.read.name, file=self.file)
class SingleEndPipeline:
"""
Processing pipeline that loops over reads and applies modifiers and filters
"""
def __init__(self, reader, modifiers, filters):
self.reader = reader
self.modifiers = modifiers
self.filters = filters
def run(self):
"""Run the pipeline. Return a Statistics object"""
n = 0 # no. of processed reads
total_bp = 0
for read in self.reader:
n += 1
total_bp += len(read.sequence)
for modifier in self.modifiers:
read = modifier(read)
for filter in self.filters:
if filter(read):
break
return Statistics(n=n, total_bp1=total_bp, total_bp2=None)
class PairedEndPipeline:
"""
Processing pipeline for paired-end reads.
"""
def __init__(self, paired_reader, modifiers1, modifiers2, filters):
self.paired_reader = paired_reader
self.modifiers1 = modifiers1
self.modifiers2 = modifiers2
self.filters = filters
def run(self):
n = 0 # no. of processed reads
total1_bp = 0
total2_bp = 0
for read1, read2 in self.paired_reader:
n += 1
total1_bp += len(read1.sequence)
total2_bp += len(read2.sequence)
for modifier in self.modifiers1:
read1 = modifier(read1)
for modifier in self.modifiers2:
read2 = modifier(read2)
for filter in self.filters:
# Stop writing as soon as one of the filters was successful.
if filter(read1, read2):
break
return Statistics(n=n, total_bp1=total1_bp, total_bp2=total2_bp)
def setup_logging(stdout=False, quiet=False):
"""
Attach handler to the global logger object
"""
# Due to backwards compatibility, logging output is sent to standard output
# instead of standard error if the -o option is used.
stream_handler = logging.StreamHandler(sys.stdout if stdout else sys.stderr)
stream_handler.setFormatter(logging.Formatter('%(message)s'))
stream_handler.setLevel(logging.ERROR if quiet else logging.INFO)
logger.setLevel(logging.INFO)
logger.addHandler(stream_handler)
def get_option_parser():
parser = CutadaptOptionParser(usage=__doc__, version=__version__)
parser.add_option("--debug", action='store_true', default=False,
help="Print debugging information.")
parser.add_option("-f", "--format",
help="Input file format; can be either 'fasta', 'fastq' or 'sra-fastq'. "
"Ignored when reading csfasta/qual files. Default: auto-detect "
"from file name extension.")
group = OptionGroup(parser, "Finding adapters:",
description="Parameters -a, -g, -b specify adapters to be removed from "
"each read (or from the first read in a pair if data is paired). "
"If specified multiple times, only the best matching adapter is "
"trimmed (but see the --times option). When the special notation "
"'file:FILE' is used, adapter sequences are read from the given "
"FASTA file.")
group.add_option("-a", "--adapter", action="append", default=[], metavar="ADAPTER",
dest="adapters",
help="Sequence of an adapter ligated to the 3' end (paired data: of the "
"first read). The adapter and subsequent bases are trimmed. If a "
"'$' character is appended ('anchoring'), the adapter is only "
"found if it is a suffix of the read.")
group.add_option("-g", "--front", action="append", default=[], metavar="ADAPTER",
help="Sequence of an adapter ligated to the 5' end (paired data: of the "
"first read). The adapter and any preceding bases are trimmed. "
"Partial matches at the 5' end are allowed. If a '^' character is "
"prepended ('anchoring'), the adapter is only found if it is a "
"prefix of the read.")
group.add_option("-b", "--anywhere", action="append", default=[], metavar="ADAPTER",
help="Sequence of an adapter that may be ligated to the 5' or 3' end "
"(paired data: of the first read). Both types of matches as "
"described under -a und -g are allowed. If the first base of the "
"read is part of the match, the behavior is as with -g, otherwise "
"as with -a. This option is mostly for rescuing failed library "
"preparations - do not use if you know which end your adapter was "
"ligated to!")
group.add_option("-e", "--error-rate", type=float, default=0.1,
help="Maximum allowed error rate (no. of errors divided by the length "
"of the matching region). Default: %default")
group.add_option("--no-indels", action='store_false', dest='indels', default=True,
help="Allow only mismatches in alignments. "
"Default: allow both mismatches and indels")
group.add_option("-n", "--times", type=int, metavar="COUNT", default=1,
help="Remove up to COUNT adapters from each read. Default: %default")
group.add_option("-O", "--overlap", type=int, metavar="MINLENGTH", default=3,
help="If the overlap between the read and the adapter is shorter than "
"MINLENGTH, the read is not modified. Reduces the no. of bases "
"trimmed due to random adapter matches. Default: %default")
group.add_option("--match-read-wildcards", action="store_true", default=False,
help="Interpret IUPAC wildcards in reads. Default: %default")
group.add_option("-N", "--no-match-adapter-wildcards", action="store_false",
default=True, dest='match_adapter_wildcards',
help="Do not interpret IUPAC wildcards in adapters.")
group.add_option("--no-trim", dest='action', action='store_const', const=None,
help="Match and redirect reads to output/untrimmed-output as usual, "
"but do not remove adapters.")
group.add_option("--mask-adapter", dest='action', action='store_const', const='mask',
help="Mask adapters with 'N' characters instead of trimming them.")
parser.add_option_group(group)
group = OptionGroup(parser, "Additional read modifications")
group.add_option("-u", "--cut", action='append', default=[], type=int, metavar="LENGTH",
help="Remove bases from each read (first read only if paired). "
"If LENGTH is positive, remove bases from the beginning. "
"If LENGTH is negative, remove bases from the end. "
"Can be used twice if LENGTHs have different signs.")
group.add_option("--nextseq-trim", type=int, default=None, metavar="3'CUTOFF",
help="NextSeq-specific quality trimming (each read). Trims also dark "
"cycles appearing as high-quality G bases (EXPERIMENTAL).")
group.add_option("-q", "--quality-cutoff", default=None, metavar="[5'CUTOFF,]3'CUTOFF",
help="Trim low-quality bases from 5' and/or 3' ends of each read before "
"adapter removal. Applied to both reads if data is paired. If one "
"value is given, only the 3' end is trimmed. If two "
"comma-separated cutoffs are given, the 5' end is trimmed with "
"the first cutoff, the 3' end with the second.")
group.add_option("--quality-base", type=int, default=33,
help="Assume that quality values in FASTQ are encoded as ascii(quality "
"+ QUALITY_BASE). This needs to be set to 64 for some old Illumina "
"FASTQ files. Default: %default")
group.add_option("--length", "-l", type=int, default=None, metavar="LENGTH",
help="Shorten reads to LENGTH. This and the following modifications"
"are applied after adapter trimming.")
group.add_option("--trim-n", action='store_true', default=False,
help="Trim N's on ends of reads.")
group.add_option("--length-tag", metavar="TAG",
help="Search for TAG followed by a decimal number in the description "
"field of the read. Replace the decimal number with the correct "
"length of the trimmed read. For example, use --length-tag 'length=' "
"to correct fields like 'length=123'.")
group.add_option("--strip-suffix", action='append', default=[],
help="Remove this suffix from read names if present. Can be given multiple times.")
group.add_option("-x", "--prefix", default='',
help="Add this prefix to read names. Use {name} to insert the name of the matching adapter.")
group.add_option("-y", "--suffix", default='',
help="Add this suffix to read names; can also include {name}")
parser.add_option_group(group)
group = OptionGroup(parser, "Filtering of processed reads")
group.add_option("-m", "--minimum-length", type=int, default=0, metavar="LENGTH",
help="Discard trimmed reads that are shorter than LENGTH. Reads that "
"are too short even before adapter removal are also discarded. In "
"colorspace, an initial primer is not counted. Default: 0")
group.add_option("-M", "--maximum-length", type=int, default=sys.maxsize, metavar="LENGTH",
help="Discard trimmed reads that are longer than LENGTH. "
"Reads that are too long even before adapter removal "
"are also discarded. In colorspace, an initial primer "
"is not counted. Default: no limit")
group.add_option("--max-n", type=float, default=-1.0, metavar="COUNT",
help="Discard reads with too many N bases. If COUNT is an integer, it "
"is treated as the absolute number of N bases. If it is between 0 "
"and 1, it is treated as the proportion of N's allowed in a read.")
group.add_option("--discard-trimmed", "--discard", action='store_true', default=False,
help="Discard reads that contain an adapter. Also use -O to avoid "
"discarding too many randomly matching reads!")
group.add_option("--discard-untrimmed", "--trimmed-only", action='store_true', default=False,
help="Discard reads that do not contain the adapter.")
parser.add_option_group(group)
group = OptionGroup(parser, "Output")
group.add_option("--quiet", default=False, action='store_true',
help="Print only error messages.")
group.add_option("-o", "--output", metavar="FILE",
help="Write trimmed reads to FILE. FASTQ or FASTA format is chosen "
"depending on input. The summary report is sent to standard output. "
"Use '{name}' in FILE to demultiplex reads into multiple "
"files. Default: write to standard output")
group.add_option("--info-file", metavar="FILE",
help="Write information about each read and its adapter matches into FILE. "
"See the documentation for the file format.")
group.add_option("-r", "--rest-file", metavar="FILE",
help="When the adapter matches in the middle of a read, write the "
"rest (after the adapter) into FILE.")
group.add_option("--wildcard-file", metavar="FILE",
help="When the adapter has N bases (wildcards), write adapter bases "
"matching wildcard positions to FILE. When there are indels in the "
"alignment, this will often not be accurate.")
group.add_option("--too-short-output", metavar="FILE",
help="Write reads that are too short (according to length specified by "
"-m) to FILE. Default: discard reads")
group.add_option("--too-long-output", metavar="FILE",
help="Write reads that are too long (according to length specified by "
"-M) to FILE. Default: discard reads")
group.add_option("--untrimmed-output", default=None, metavar="FILE",
help="Write reads that do not contain the adapter to FILE. Default: "
"output to same file as trimmed reads")
parser.add_option_group(group)
group = OptionGroup(parser, "Colorspace options")
group.add_option("-c", "--colorspace", action='store_true', default=False,
help="Enable colorspace mode: Also trim the color that is adjacent to the found adapter.")
group.add_option("-d", "--double-encode", action='store_true', default=False,
help="Double-encode colors (map 0,1,2,3,4 to A,C,G,T,N).")
group.add_option("-t", "--trim-primer", action='store_true', default=False,
help="Trim primer base and the first color (which is the transition "
"to the first nucleotide)")
group.add_option("--strip-f3", action='store_true', default=False,
help="Strip the _F3 suffix of read names")
group.add_option("--maq", "--bwa", action='store_true', default=False,
help="MAQ- and BWA-compatible colorspace output. This enables -c, -d, "
"-t, --strip-f3 and -y '/1'.")
group.add_option("--no-zero-cap", dest='zero_cap', action='store_false',
help="Do not change negative quality values to zero in colorspace "
"data. By default, they are since many tools have problems with "
"negative qualities.")
group.add_option("--zero-cap", "-z", action='store_true',
help="Change negative quality values to zero. This is enabled "
"by default when -c/--colorspace is also enabled. Use the above option "
"to disable it.")
parser.set_defaults(zero_cap=None, action='trim')
parser.add_option_group(group)
group = OptionGroup(parser, "Paired-end options", description="The "
"-A/-G/-B/-U options work like their -a/-b/-g/-u counterparts, but "
"are applied to the second read in each pair.")
group.add_option("-A", dest='adapters2', action='append', default=[], metavar='ADAPTER',
help="3' adapter to be removed from second read in a pair.")
group.add_option("-G", dest='front2', action='append', default=[], metavar='ADAPTER',
help="5' adapter to be removed from second read in a pair.")
group.add_option("-B", dest='anywhere2', action='append', default=[], metavar='ADAPTER',
help="5'/3 adapter to be removed from second read in a pair.")
group.add_option("-U", dest='cut2', action='append', default=[], type=int, metavar="LENGTH",
help="Remove LENGTH bases from second read in a pair (see --cut).")
group.add_option("-p", "--paired-output", metavar="FILE",
help="Write second read in a pair to FILE.")
# Setting the default for pair_filter to None allows us to find out whether
# the option was used at all.
group.add_option("--pair-filter", metavar='(any|both)', default=None,
choices=("any", "both"),
help="Which of the reads in a paired-end read have to match the "
"filtering criterion in order for it to be filtered. "
"Default: any")
group.add_option("--interleaved", action='store_true', default=False,
help="Read and write interleaved paired-end reads.")
group.add_option("--untrimmed-paired-output", metavar="FILE",
help="Write second read in a pair to this FILE when no adapter "
"was found in the first read. Use this option together with "
"--untrimmed-output when trimming paired-end reads. Default: output "
"to same file as trimmed reads")
group.add_option("--too-short-paired-output", metavar="FILE", default=None,
help="Write second read in a pair to this file if pair is too short. "
"Use together with --too-short-output.")
group.add_option("--too-long-paired-output", metavar="FILE", default=None,
help="Write second read in a pair to this file if pair is too long. "
"Use together with --too-long-output.")
parser.add_option_group(group)
return parser
def main(cmdlineargs=None, default_outfile=sys.stdout):
"""
Main function that evaluates command-line parameters and iterates
over all reads.
default_outfile is the file to which trimmed reads are sent if the ``-o``
parameter is not used.
"""
parser = get_option_parser()
if cmdlineargs is None:
cmdlineargs = sys.argv[1:]
options, args = parser.parse_args(args=cmdlineargs)
# Setup logging only if there are not already any handlers (can happen when
# this function is being called externally such as from unit tests)
if not logging.root.handlers:
setup_logging(stdout=bool(options.output), quiet=options.quiet)
if len(args) == 0:
parser.error("At least one parameter needed: name of a FASTA or FASTQ file.")
elif len(args) > 2:
parser.error("Too many parameters.")
input_filename = args[0]
if input_filename.endswith('.qual'):
parser.error("If a .qual file is given, it must be the second argument.")
# Find out which 'mode' we need to use.
# Default: single-read trimming (neither -p nor -A/-G/-B/-U/--interleaved given)
paired = False
if options.paired_output:
# Modify first read only, keep second in sync (-p given, but not -A/-G/-B/-U).
# This exists for backwards compatibility ('legacy mode').
paired = 'first'
# Any of these options switch off legacy mode
if (options.adapters2 or options.front2 or options.anywhere2 or
options.cut2 or options.interleaved or options.pair_filter or
options.too_short_paired_output or options.too_long_paired_output):
# Full paired-end trimming when both -p and -A/-G/-B/-U given
# Read modifications (such as quality trimming) are applied also to second read.
paired = 'both'
if paired and len(args) == 1 and not options.interleaved:
parser.error("When paired-end trimming is enabled via -A/-G/-B/-U/"
"--interleaved or -p, two input files are required.")
if not paired:
if options.untrimmed_paired_output:
parser.error("Option --untrimmed-paired-output can only be used when "
"trimming paired-end reads (with option -p).")
interleaved_input = False
interleaved_output = False
if options.interleaved:
interleaved_input = len(args) == 1
interleaved_output = not options.paired_output
if not interleaved_input and not interleaved_output:
parser.error("When --interleaved is used, you cannot provide both two input files and two output files")
# Assign input_paired_filename and quality_filename
input_paired_filename = None
quality_filename = None
if paired:
if not interleaved_input:
input_paired_filename = args[1]
if not interleaved_output:
if not options.paired_output:
parser.error("When paired-end trimming is enabled via -A/-G/-B/-U, "
"a second output file needs to be specified via -p (--paired-output).")
if not options.output:
parser.error("When you use -p or --paired-output, you must also "
"use the -o option.")
if bool(options.untrimmed_output) != bool(options.untrimmed_paired_output):
parser.error("When trimming paired-end reads, you must use either none "
"or both of the --untrimmed-output/--untrimmed-paired-output options.")
if options.too_short_output and not options.too_short_paired_output:
parser.error("When using --too-short-output with paired-end "
"reads, you also need to use --too-short-paired-output")
if options.too_long_output and not options.too_long_paired_output:
parser.error("When using --too-long-output with paired-end "
"reads, you also need to use --too-long-paired-output")
elif len(args) == 2:
quality_filename = args[1]
if options.format is not None:
parser.error("If a pair of .fasta and .qual files is given, the -f/--format parameter cannot be used.")
if options.format is not None and options.format.lower() not in ['fasta', 'fastq', 'sra-fastq']:
parser.error("The input file format must be either 'fasta', 'fastq' or "
"'sra-fastq' (not '{0}').".format(options.format))
# Open input file(s)
try:
reader = seqio.open(input_filename, file2=input_paired_filename,
qualfile=quality_filename, colorspace=options.colorspace,
fileformat=options.format, interleaved=interleaved_input)
except (seqio.UnknownFileType, IOError) as e:
parser.error(e)
if options.quality_cutoff is not None:
cutoffs = options.quality_cutoff.split(',')
if len(cutoffs) == 1:
try:
cutoffs = [0, int(cutoffs[0])]
except ValueError as e:
parser.error("Quality cutoff value not recognized: {0}".format(e))
elif len(cutoffs) == 2:
try:
cutoffs = [int(cutoffs[0]), int(cutoffs[1])]
except ValueError as e:
parser.error("Quality cutoff value not recognized: {0}".format(e))
else:
parser.error("Expected one value or two values separated by comma for the quality cutoff")
else:
cutoffs = None
open_writer = functools.partial(seqio.open, mode='w',
qualities=reader.delivers_qualities, colorspace=options.colorspace)
if options.pair_filter is None:
options.pair_filter = 'any'
min_affected = 2 if options.pair_filter == 'both' else 1
if not paired:
filter_wrapper = Redirector
elif paired == 'first':
filter_wrapper = LegacyPairedRedirector
elif paired == 'both':
filter_wrapper = functools.partial(PairedRedirector, min_affected=min_affected)
filters = []
# TODO open_files = []
too_short_writer = None # too short reads go here
# TODO pass file name to TooShortReadFilter, add a .close() method?
if options.minimum_length > 0:
if options.too_short_output:
too_short_writer = open_writer(options.too_short_output, options.too_short_paired_output)
filters.append(filter_wrapper(too_short_writer, TooShortReadFilter(options.minimum_length)))
too_long_writer = None # too long reads go here
if options.maximum_length < sys.maxsize:
if options.too_long_output is not None:
too_long_writer = open_writer(options.too_long_output, options.too_long_paired_output)
filters.append(filter_wrapper(too_long_writer, TooLongReadFilter(options.maximum_length)))
if options.max_n != -1:
filters.append(filter_wrapper(None, NContentFilter(options.max_n)))
if int(options.discard_trimmed) + int(options.discard_untrimmed) + int(options.untrimmed_output is not None) > 1:
parser.error("Only one of the --discard-trimmed, --discard-untrimmed "
"and --untrimmed-output options can be used at the same time.")
demultiplexer = None
untrimmed_writer = None
writer = None
if options.output is not None and '{name}' in options.output:
if options.discard_trimmed:
parser.error("Do not use --discard-trimmed when demultiplexing.")
if paired:
parser.error("Demultiplexing not supported for paired-end files, yet.")
untrimmed = options.output.replace('{name}', 'unknown')
if options.untrimmed_output:
untrimmed = options.untrimmed_output
if options.discard_untrimmed:
untrimmed = None
demultiplexer = Demultiplexer(options.output, untrimmed,
qualities=reader.delivers_qualities, colorspace=options.colorspace)
filters.append(demultiplexer)
else:
# Set up the remaining filters to deal with --discard-trimmed,
# --discard-untrimmed and --untrimmed-output. These options
# are mutually exclusive in order to avoid brain damage.
if options.discard_trimmed:
filters.append(filter_wrapper(None, DiscardTrimmedFilter()))
elif options.discard_untrimmed:
filters.append(filter_wrapper(None, DiscardUntrimmedFilter()))
elif options.untrimmed_output:
untrimmed_writer = open_writer(options.untrimmed_output,
options.untrimmed_paired_output)
filters.append(filter_wrapper(untrimmed_writer, DiscardUntrimmedFilter()))
# Finally, figure out where the reads that passed all the previous
# filters should go.
if options.output is not None:
writer = open_writer(options.output, options.paired_output, interleaved=interleaved_output)
else:
writer = open_writer(default_outfile, interleaved=interleaved_output)
if not paired:
filters.append(NoFilter(writer))
else:
filters.append(PairedNoFilter(writer))
if options.maq:
options.colorspace = True
options.double_encode = True
options.trim_primer = True
options.strip_suffix.append('_F3')
options.suffix = "/1"
if options.zero_cap is None:
options.zero_cap = options.colorspace
if options.trim_primer and not options.colorspace:
parser.error("Trimming the primer makes only sense in colorspace.")
if options.double_encode and not options.colorspace:
parser.error("Double-encoding makes only sense in colorspace.")
if options.anywhere and options.colorspace:
parser.error("Using --anywhere with colorspace reads is currently not supported (if you think this may be useful, contact the author).")
if not (0 <= options.error_rate <= 1.):
parser.error("The maximum error rate must be between 0 and 1.")
if options.overlap < 1:
parser.error("The overlap must be at least 1.")
if options.rest_file is not None:
options.rest_file = xopen(options.rest_file, 'w')
rest_writer = RestFileWriter(options.rest_file)
else:
rest_writer = None
if options.info_file is not None:
options.info_file = xopen(options.info_file, 'w')
if options.wildcard_file is not None:
options.wildcard_file = xopen(options.wildcard_file, 'w')
if options.colorspace:
if options.match_read_wildcards:
parser.error('IUPAC wildcards not supported in colorspace')
options.match_adapter_wildcards = False
adapter_parser = AdapterParser(
colorspace=options.colorspace,
max_error_rate=options.error_rate,
min_overlap=options.overlap,
read_wildcards=options.match_read_wildcards,
adapter_wildcards=options.match_adapter_wildcards,
indels=options.indels)
try:
adapters = adapter_parser.parse_multi(options.adapters, options.anywhere, options.front)
adapters2 = adapter_parser.parse_multi(options.adapters2, options.anywhere2, options.front2)
except IOError as e:
if e.errno == errno.ENOENT:
parser.error(e)
raise
except ValueError as e:
parser.error(e)
if options.debug:
for adapter in adapters + adapters2:
adapter.enable_debug()
# Create the single-end processing pipeline (a list of "modifiers")
modifiers = []
if options.cut:
if len(options.cut) > 2:
parser.error("You cannot remove bases from more than two ends.")
if len(options.cut) == 2 and options.cut[0] * options.cut[1] > 0:
parser.error("You cannot remove bases from the same end twice.")
for cut in options.cut:
if cut != 0:
modifiers.append(UnconditionalCutter(cut))
if options.nextseq_trim is not None:
modifiers.append(NextseqQualityTrimmer(options.nextseq_trim, options.quality_base))
if cutoffs:
modifiers.append(QualityTrimmer(cutoffs[0], cutoffs[1], options.quality_base))
if adapters:
adapter_cutter = AdapterCutter(adapters, options.times,
options.wildcard_file, options.info_file,
rest_writer, options.action)
modifiers.append(adapter_cutter)
# Modifiers that apply to both reads of paired-end reads unless in legacy mode
modifiers_both = []
if options.length is not None:
modifiers_both.append(Shortener(options.length))
if options.trim_n:
modifiers_both.append(NEndTrimmer())
if options.length_tag:
modifiers_both.append(LengthTagModifier(options.length_tag))
if options.strip_f3:
options.strip_suffix.append('_F3')
for suffix in options.strip_suffix:
modifiers_both.append(SuffixRemover(suffix))
if options.prefix or options.suffix:
modifiers_both.append(PrefixSuffixAdder(options.prefix, options.suffix))
if options.double_encode:
modifiers_both.append(DoubleEncoder())
if options.zero_cap and reader.delivers_qualities:
modifiers_both.append(ZeroCapper(quality_base=options.quality_base))
if options.trim_primer:
modifiers_both.append(PrimerTrimmer)
modifiers.extend(modifiers_both)
# For paired-end data, create a second processing pipeline.
# However, if no second-read adapters were given (via -A/-G/-B/-U), we need to
# be backwards compatible and *no modifications* are done to the second read.
modifiers2 = []
if paired == 'both':
if options.cut2:
if len(options.cut2) > 2:
parser.error("You cannot remove bases from more than two ends.")
if len(options.cut2) == 2 and options.cut2[0] * options.cut2[1] > 0:
parser.error("You cannot remove bases from the same end twice.")
for cut in options.cut2:
if cut != 0:
modifiers2.append(UnconditionalCutter(cut))
if cutoffs:
modifiers2.append(QualityTrimmer(cutoffs[0], cutoffs[1], options.quality_base))
if adapters2:
adapter_cutter2 = AdapterCutter(adapters2, options.times,
None, None, None, options.action)
modifiers2.append(adapter_cutter2)
else:
adapter_cutter2 = None
modifiers2.extend(modifiers_both)
if paired:
pipeline = PairedEndPipeline(reader, modifiers, modifiers2, filters)
else:
pipeline = SingleEndPipeline(reader, modifiers, filters)
logger.info("This is cutadapt %s with Python %s", __version__, platform.python_version())
logger.info("Command line parameters: %s", " ".join(cmdlineargs))
logger.info("Trimming %s adapter%s with at most %.1f%% errors in %s mode ...",
len(adapters) + len(adapters2), 's' if len(adapters) + len(adapters2) != 1 else '',
options.error_rate * 100,
{ False: 'single-end', 'first': 'paired-end legacy', 'both': 'paired-end' }[paired])
if paired == 'first' and (modifiers_both or cutoffs):
logger.warning('\n'.join(textwrap.wrap('WARNING: Requested read '
'modifications are applied only to the first '
'read since backwards compatibility mode is enabled. '
'To modify both reads, also use any of the -A/-B/-G/-U options. '
'Use a dummy adapter sequence when necessary: -A XXX')))
start_time = time.clock()
try:
stats = pipeline.run()
except KeyboardInterrupt as e:
print("Interrupted", file=sys.stderr)
sys.exit(130)
except IOError as e:
if e.errno == errno.EPIPE:
sys.exit(1)
raise
except (seqio.FormatError, EOFError) as e:
sys.exit("cutadapt: error: {0}".format(e))
# close open files
for f in [writer, untrimmed_writer,
options.rest_file, options.wildcard_file,
options.info_file, too_short_writer, too_long_writer,
options.info_file, demultiplexer]:
if f is not None and f is not sys.stdin and f is not sys.stdout:
f.close()
elapsed_time = time.clock() - start_time
if not options.quiet:
stats.collect((adapters, adapters2), elapsed_time,
modifiers, modifiers2, filters)
# send statistics to stderr if result was sent to stdout
stat_file = sys.stderr if options.output is None else None
with redirect_standard_output(stat_file):
print_report(stats, (adapters, adapters2))
if __name__ == '__main__':
main()
|