org.dishevelled.bio.tools.InterleaveFastq Maven / Gradle / Ivy
The newest version!
/*
dsh-bio-tools Command line tools.
Copyright (c) 2013-2024 held jointly by the individual authors.
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 3 of the License, or (at
your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
> http://www.fsf.org/licensing/licenses/lgpl.html
> http://www.opensource.org/licenses/lgpl-license.php
*/
package org.dishevelled.bio.tools;
import static com.google.common.base.Preconditions.checkNotNull;
import static org.dishevelled.compress.Readers.reader;
import static org.dishevelled.compress.Writers.writer;
import java.io.BufferedReader;
import java.io.File;
import java.io.PrintWriter;
import java.io.IOException;
import java.nio.file.Path;
import java.util.concurrent.Callable;
import org.biojava.bio.program.fastq.Fastq;
import org.biojava.bio.program.fastq.FastqWriter;
import org.biojava.bio.program.fastq.SangerFastqWriter;
import org.dishevelled.bio.read.PairedEndAdapter;
import org.dishevelled.bio.read.PairedEndFastqReader;
import org.dishevelled.commandline.ArgumentList;
import org.dishevelled.commandline.CommandLine;
import org.dishevelled.commandline.CommandLineParseException;
import org.dishevelled.commandline.CommandLineParser;
import org.dishevelled.commandline.Switch;
import org.dishevelled.commandline.Usage;
import org.dishevelled.commandline.argument.FileArgument;
import org.dishevelled.commandline.argument.PathArgument;
/**
* Convert first and second DNA sequence files in FASTQ format to interleaved FASTQ format.
*
* @author Michael Heuer
*/
public final class InterleaveFastq implements Callable {
private final Path firstFastqPath;
private final Path secondFastqPath;
private final File pairedFile;
private final File unpairedFile;
private static final String USAGE = "dsh-interleave-fastq -1 foo_1.fq.gz -2 foo_2.fq.gz -p foo.paired.fq.gz -u foo.unpaired.fq.gz";
/**
* Convert first and second DNA sequence files in FASTQ format to interleaved FASTQ format.
*
* @deprecated will be removed in version 3.0
* @param firstFastqFile first FASTQ input file, must not be null
* @param secondFastqFile second FASTQ input file, must not be null
* @param pairedFile output interleaved paired FASTQ file, must not be null
* @param unpairedFile output unpaired FASTQ file, must not be null
*/
public InterleaveFastq(final File firstFastqFile, final File secondFastqFile, final File pairedFile, final File unpairedFile) {
this(firstFastqFile == null ? null : firstFastqFile.toPath(),
secondFastqFile == null ? null : secondFastqFile.toPath(),
pairedFile,
unpairedFile);
}
/**
* Convert first and second DNA sequence files in FASTQ format to interleaved FASTQ format.
*
* @since 2.1
* @param firstFastqPath first FASTQ input path, must not be null
* @param secondFastqPath second FASTQ input path, must not be null
* @param pairedFile output interleaved paired FASTQ file, must not be null
* @param unpairedFile output unpaired FASTQ file, must not be null
*/
public InterleaveFastq(final Path firstFastqPath, final Path secondFastqPath, final File pairedFile, final File unpairedFile) {
checkNotNull(firstFastqPath);
checkNotNull(secondFastqPath);
checkNotNull(pairedFile);
checkNotNull(unpairedFile);
this.firstFastqPath = firstFastqPath;
this.secondFastqPath = secondFastqPath;
this.pairedFile = pairedFile;
this.unpairedFile = unpairedFile;
}
@Override
public Integer call() throws Exception {
BufferedReader firstReader = null;
BufferedReader secondReader = null;
PrintWriter pairedWriter = null;
PrintWriter unpairedWriter = null;
try {
firstReader = reader(firstFastqPath);
secondReader = reader(secondFastqPath);
pairedWriter = writer(pairedFile);
unpairedWriter = writer(unpairedFile);
final PrintWriter pw = pairedWriter;
final PrintWriter uw = unpairedWriter;
final FastqWriter pairedFastqWriter = new SangerFastqWriter();
final FastqWriter unpairedFastqWriter = new SangerFastqWriter();
PairedEndFastqReader.streamPaired(firstReader, secondReader, new PairedEndAdapter() {
@Override
public void paired(final Fastq left, final Fastq right) {
try {
pairedFastqWriter.append(pw, left);
pairedFastqWriter.append(pw, right);
}
catch (IOException e) {
throw new RuntimeException("could not write paired end reads", e);
}
}
@Override
public void unpaired(final Fastq unpaired) {
try {
unpairedFastqWriter.append(uw, unpaired);
}
catch (IOException e) {
throw new RuntimeException("could not write unpaired read", e);
}
}
});
return 0;
}
finally {
try {
firstReader.close();
}
catch (Exception e) {
// ignore
}
try {
secondReader.close();
}
catch (Exception e) {
// ignore
}
try {
pairedWriter.close();
}
catch (Exception e) {
// ignore
}
try {
unpairedWriter.close();
}
catch (Exception e) {
// ignore
}
}
}
/**
* Main.
*
* @param args command line args
*/
public static void main(final String[] args) {
Switch about = new Switch("a", "about", "display about message");
Switch help = new Switch("h", "help", "display help message");
PathArgument firstFastqPath = new PathArgument("1", "first-fastq-path", "first FASTQ input path", true);
PathArgument secondFastqPath = new PathArgument("2", "second-fastq-path", "second FASTQ input path", true);
FileArgument pairedFile = new FileArgument("p", "paired-file", "output interleaved paired FASTQ file", true);
FileArgument unpairedFile = new FileArgument("u", "unpaired-file", "output unpaired FASTQ file", true);
ArgumentList arguments = new ArgumentList(about, help, firstFastqPath, secondFastqPath, pairedFile, unpairedFile);
CommandLine commandLine = new CommandLine(args);
InterleaveFastq interleaveFastq = null;
try {
CommandLineParser.parse(commandLine, arguments);
if (about.wasFound()) {
About.about(System.out);
System.exit(0);
}
if (help.wasFound()) {
Usage.usage(USAGE, null, commandLine, arguments, System.out);
System.exit(0);
}
interleaveFastq = new InterleaveFastq(firstFastqPath.getValue(), secondFastqPath.getValue(), pairedFile.getValue(), unpairedFile.getValue());
}
catch (CommandLineParseException e) {
if (about.wasFound()) {
About.about(System.out);
System.exit(0);
}
if (help.wasFound()) {
Usage.usage(USAGE, null, commandLine, arguments, System.out);
System.exit(0);
}
Usage.usage(USAGE, e, commandLine, arguments, System.err);
System.exit(-1);
}
try {
System.exit(interleaveFastq.call());
}
catch (Exception e) {
e.printStackTrace();
System.exit(1);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy