Mercurial > repos > kkonganti > cfsan_centriflaken

annotate 0.3.0/bin/fastq_dir_to_samplesheet.py @ 92:295c2597a475

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload"
author kkonganti
date Tue, 19 Jul 2022 10:07:24 -0400
parents
children
rev   line source
kkonganti@92 1 #!/usr/bin/env python3
kkonganti@92 2
kkonganti@92 3 import os
kkonganti@92 4 import sys
kkonganti@92 5 import glob
kkonganti@92 6 import argparse
kkonganti@92 7 import re
kkonganti@92 8
kkonganti@92 9
kkonganti@92 10 def parse_args(args=None):
kkonganti@92 11 Description = "Generate samplesheet from a directory of FastQ files."
kkonganti@92 12 Epilog = "Example usage: python fastq_dir_to_samplesheet.py <FASTQ_DIR> <SAMPLESHEET_FILE>"
kkonganti@92 13
kkonganti@92 14 parser = argparse.ArgumentParser(description=Description, epilog=Epilog)
kkonganti@92 15 parser.add_argument("FASTQ_DIR", help="Folder containing raw FastQ files.")
kkonganti@92 16 parser.add_argument("SAMPLESHEET_FILE", help="Output samplesheet file.")
kkonganti@92 17 parser.add_argument(
kkonganti@92 18 "-st",
kkonganti@92 19 "--strandedness",
kkonganti@92 20 type=str,
kkonganti@92 21 dest="STRANDEDNESS",
kkonganti@92 22 default="unstranded",
kkonganti@92 23 help="Value for 'strandedness' in samplesheet. Must be one of 'unstranded', 'forward', 'reverse'.",
kkonganti@92 24 )
kkonganti@92 25 parser.add_argument(
kkonganti@92 26 "-r1",
kkonganti@92 27 "--read1_extension",
kkonganti@92 28 type=str,
kkonganti@92 29 dest="READ1_EXTENSION",
kkonganti@92 30 default="_R1_001.fastq.gz",
kkonganti@92 31 help="File extension for read 1.",
kkonganti@92 32 )
kkonganti@92 33 parser.add_argument(
kkonganti@92 34 "-r2",
kkonganti@92 35 "--read2_extension",
kkonganti@92 36 type=str,
kkonganti@92 37 dest="READ2_EXTENSION",
kkonganti@92 38 default="_R2_001.fastq.gz",
kkonganti@92 39 help="File extension for read 2.",
kkonganti@92 40 )
kkonganti@92 41 parser.add_argument(
kkonganti@92 42 "-se",
kkonganti@92 43 "--single_end",
kkonganti@92 44 dest="SINGLE_END",
kkonganti@92 45 action="store_true",
kkonganti@92 46 help="Single-end information will be auto-detected but this option forces paired-end FastQ files to be treated as single-end so only read 1 information is included in the samplesheet.",
kkonganti@92 47 )
kkonganti@92 48 parser.add_argument(
kkonganti@92 49 "-sn",
kkonganti@92 50 "--sanitise_name",
kkonganti@92 51 dest="SANITISE_NAME",
kkonganti@92 52 action="store_true",
kkonganti@92 53 help="Whether to further sanitise FastQ file name to get sample id. Used in conjunction with --sanitise_name_delimiter and --sanitise_name_index.",
kkonganti@92 54 )
kkonganti@92 55 parser.add_argument(
kkonganti@92 56 "-sd",
kkonganti@92 57 "--sanitise_name_delimiter",
kkonganti@92 58 type=str,
kkonganti@92 59 dest="SANITISE_NAME_DELIMITER",
kkonganti@92 60 default="_",
kkonganti@92 61 help="Delimiter to use to sanitise sample name.",
kkonganti@92 62 )
kkonganti@92 63 parser.add_argument(
kkonganti@92 64 "-si",
kkonganti@92 65 "--sanitise_name_index",
kkonganti@92 66 type=int,
kkonganti@92 67 dest="SANITISE_NAME_INDEX",
kkonganti@92 68 default=1,
kkonganti@92 69 help="After splitting FastQ file name by --sanitise_name_delimiter all elements before this index (1-based) will be joined to create final sample name.",
kkonganti@92 70 )
kkonganti@92 71 return parser.parse_args(args)
kkonganti@92 72
kkonganti@92 73
kkonganti@92 74 def fastq_dir_to_samplesheet(
kkonganti@92 75 fastq_dir,
kkonganti@92 76 samplesheet_file,
kkonganti@92 77 strandedness="unstranded",
kkonganti@92 78 read1_extension="_R1_001.fastq.gz",
kkonganti@92 79 read2_extension="_R2_001.fastq.gz",
kkonganti@92 80 single_end=False,
kkonganti@92 81 sanitise_name=False,
kkonganti@92 82 sanitise_name_delimiter="_",
kkonganti@92 83 sanitise_name_index=1,
kkonganti@92 84 ):
kkonganti@92 85 def sanitize_sample(path, extension):
kkonganti@92 86 """Retrieve sample id from filename"""
kkonganti@92 87 sample = os.path.basename(path).replace(extension, "")
kkonganti@92 88 if sanitise_name:
kkonganti@92 89 if sanitise_name_index > 0:
kkonganti@92 90 sample = sanitise_name_delimiter.join(
kkonganti@92 91 os.path.basename(path).split(sanitise_name_delimiter)[
kkonganti@92 92 :sanitise_name_index
kkonganti@92 93 ]
kkonganti@92 94 )
kkonganti@92 95 # elif sanitise_name_index == -1:
kkonganti@92 96 # sample = os.path.basename(path)[ :os.path.basename(path).index('.') ]
kkonganti@92 97 return sample
kkonganti@92 98
kkonganti@92 99 def get_fastqs(extension):
kkonganti@92 100 """
kkonganti@92 101 Needs to be sorted to ensure R1 and R2 are in the same order
kkonganti@92 102 when merging technical replicates. Glob is not guaranteed to produce
kkonganti@92 103 sorted results.
kkonganti@92 104 See also https://stackoverflow.com/questions/6773584/how-is-pythons-glob-glob-ordered
kkonganti@92 105 """
kkonganti@92 106 abs_fq_files = glob.glob(os.path.join(fastq_dir, f"**", f"*{extension}"), recursive=True)
kkonganti@92 107 return sorted(
kkonganti@92 108 [
kkonganti@92 109 fq for _, fq in enumerate(abs_fq_files) if re.match('^((?!undetermined|unclassified|fail|class|qc|downloads).)*$', fq, flags=re.IGNORECASE)
kkonganti@92 110 ]
kkonganti@92 111 )
kkonganti@92 112
kkonganti@92 113 read_dict = {}
kkonganti@92 114
kkonganti@92 115 ## Get read 1 files
kkonganti@92 116 for read1_file in get_fastqs(read1_extension):
kkonganti@92 117 sample = sanitize_sample(read1_file, read1_extension)
kkonganti@92 118 if sample not in read_dict:
kkonganti@92 119 read_dict[sample] = {"R1": [], "R2": []}
kkonganti@92 120 read_dict[sample]["R1"].append(read1_file)
kkonganti@92 121
kkonganti@92 122 ## Get read 2 files
kkonganti@92 123 if not single_end:
kkonganti@92 124 for read2_file in get_fastqs(read2_extension):
kkonganti@92 125 sample = sanitize_sample(read2_file, read2_extension)
kkonganti@92 126 read_dict[sample]["R2"].append(read2_file)
kkonganti@92 127
kkonganti@92 128 ## Write to file
kkonganti@92 129 if len(read_dict) > 0:
kkonganti@92 130 out_dir = os.path.dirname(samplesheet_file)
kkonganti@92 131 if out_dir and not os.path.exists(out_dir):
kkonganti@92 132 os.makedirs(out_dir)
kkonganti@92 133
kkonganti@92 134 with open(samplesheet_file, "w") as fout:
kkonganti@92 135 header = ["sample", "fq1", "fq2", "strandedness"]
kkonganti@92 136 fout.write(",".join(header) + "\n")
kkonganti@92 137 for sample, reads in sorted(read_dict.items()):
kkonganti@92 138 for idx, read_1 in enumerate(reads["R1"]):
kkonganti@92 139 read_2 = ""
kkonganti@92 140 if idx < len(reads["R2"]):
kkonganti@92 141 read_2 = reads["R2"][idx]
kkonganti@92 142 sample_info = ",".join([sample, read_1, read_2, strandedness])
kkonganti@92 143 fout.write(f"{sample_info}\n")
kkonganti@92 144 else:
kkonganti@92 145 error_str = (
kkonganti@92 146 "\nWARNING: No FastQ files found so samplesheet has not been created!\n\n"
kkonganti@92 147 )
kkonganti@92 148 error_str += "Please check the values provided for the:\n"
kkonganti@92 149 error_str += " - Path to the directory containing the FastQ files\n"
kkonganti@92 150 error_str += " - '--read1_extension' parameter\n"
kkonganti@92 151 error_str += " - '--read2_extension' parameter\n"
kkonganti@92 152 print(error_str)
kkonganti@92 153 sys.exit(1)
kkonganti@92 154
kkonganti@92 155
kkonganti@92 156 def main(args=None):
kkonganti@92 157 args = parse_args(args)
kkonganti@92 158
kkonganti@92 159 strandedness = "unstranded"
kkonganti@92 160 if args.STRANDEDNESS in ["unstranded", "forward", "reverse"]:
kkonganti@92 161 strandedness = args.STRANDEDNESS
kkonganti@92 162
kkonganti@92 163 fastq_dir_to_samplesheet(
kkonganti@92 164 fastq_dir=args.FASTQ_DIR,
kkonganti@92 165 samplesheet_file=args.SAMPLESHEET_FILE,
kkonganti@92 166 strandedness=strandedness,
kkonganti@92 167 read1_extension=args.READ1_EXTENSION,
kkonganti@92 168 read2_extension=args.READ2_EXTENSION,
kkonganti@92 169 single_end=args.SINGLE_END,
kkonganti@92 170 sanitise_name=args.SANITISE_NAME,
kkonganti@92 171 sanitise_name_delimiter=args.SANITISE_NAME_DELIMITER,
kkonganti@92 172 sanitise_name_index=args.SANITISE_NAME_INDEX,
kkonganti@92 173 )
kkonganti@92 174
kkonganti@92 175
kkonganti@92 176 if __name__ == "__main__":
kkonganti@92 177 sys.exit(main())