SW_AmpIllumina-B: assay suffix changes

 - Changed "GLAmpSeq" suffix to "_GLAmpSeq" for better flexibility in naming
 - Changed order of vis script parameters, made associated readme changes

Author: torres-alexis

Amplicon/Illumina/Workflow_Documentation/SW_AmpIllumina-B/workflow_code/Snakefile

@@ -34,7 +34,7 @@ Variables that may need to be adjusted should be changed there, not here.
 ####### Assay-specific GL suffix #######
 ########################################
 
-assay_suffix = "GLAmpSeq"
+assay_suffix = "_GLAmpSeq"
 
 
 ########################################
@@ -93,27 +93,27 @@ for dir in needed_dirs:
 base_PE_inputs = [
     expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
     expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R2_suffix"], ID = sample_ID_list),
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom.zip",
-    config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-    config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv",
-    config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc_{assay_suffix}_report.zip",
-    config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc_{assay_suffix}_report.zip"
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom.zip",
+    config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+    config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv",
+    config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc{assay_suffix}_report.zip",
+    config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc{assay_suffix}_report.zip"
 ]
 
 # Base rule all inputs (final outs) for SE, with or without trimming
 base_SE_inputs = [
     expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom.zip",
-    config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-    config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv",
-    config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc_{assay_suffix}_report.zip",
-    config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc_{assay_suffix}_report.zip"
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom.zip",
+    config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+    config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+    config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv",
+    config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc{assay_suffix}_report.zip",
+    config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc{assay_suffix}_report.zip"
 ]
 
 # Add additional inputs for trimming
@@ -122,18 +122,18 @@ if config["trim_primers"] == "TRUE":
         base_PE_inputs += [
             expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R1_suffix"], ID = sample_ID_list),
             expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R2_suffix"], ID = sample_ID_list),
-            config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt_{assay_suffix}.log",
-            config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts_{assay_suffix}.tsv",
+            config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt{assay_suffix}.log",
+            config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts{assay_suffix}.tsv",
         ]
     else: # SE with primer trimming
         base_SE_inputs += [
             expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R1_suffix"], ID = sample_ID_list),
-            config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt_{assay_suffix}.log",
-            config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts_{assay_suffix}.tsv",
+            config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt{assay_suffix}.log",
+            config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts{assay_suffix}.tsv",
         ]
 
 # Conditional addition of visualization outputs (color legend only to keep it simple)
-visualization_outputs = [config["plots_dir"] + config["output_prefix"] + f"color_legend_{assay_suffix}.png"] if enable_visualizations == "TRUE" else []
+visualization_outputs = [config["plots_dir"] + config["output_prefix"] + f"color_legend{assay_suffix}.png"] if enable_visualizations == "TRUE" else []
 
 ########################################
 ############# Rules start ##############
@@ -160,16 +160,16 @@ if config["data_type"] == "PE":
             input:
                 expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R1_suffix"], ID = sample_ID_list),
                 expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R2_suffix"], ID = sample_ID_list),
-                config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts_{assay_suffix}.tsv"
+                config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts{assay_suffix}.tsv"
             output:
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R2_suffix"], ID = sample_ID_list),
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom",
-                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv"
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom",
+                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv"
             params:
                 left_trunc = config["left_trunc"],
                 right_trunc = config["right_trunc"],
@@ -211,12 +211,12 @@ if config["data_type"] == "PE":
             output:
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R2_suffix"], ID = sample_ID_list),
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom",
-                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv"
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom",
+                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv"
             params:
                 left_trunc = config["left_trunc"],
                 right_trunc = config["right_trunc"],
@@ -338,7 +338,7 @@ if config["data_type"] == "PE":
             r2_html_files = expand(config["raw_reads_dir"] + "{ID}" + config["raw_R2_suffix"].rsplit(".", 2)[0] + "_fastqc.html", ID = sample_ID_list),
             config_file = "config/multiqc.config"
         output:
-            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc_{assay_suffix}_report.zip"
+            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc{assay_suffix}_report.zip"
         benchmark:
             "benchmarks/raw_multiqc-benchmarks.tsv"
         shell:
@@ -387,7 +387,7 @@ if config["data_type"] == "PE":
             r2_html_files = expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R2_suffix"].rsplit(".", 2)[0] + "_fastqc.html", ID = sample_ID_list),
             config_file = "config/multiqc.config"
         output:
-            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc_{assay_suffix}_report.zip"
+            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc{assay_suffix}_report.zip"
         benchmark:
             "benchmarks/filtered_multiqc-benchmarks.tsv"
 
@@ -418,15 +418,15 @@ if config["data_type"] == "SE":
                 "envs/R.yaml"
             input:
                 expand(config["trimmed_reads_dir"] + "{ID}" + config["primer_trimmed_R1_suffix"], ID = sample_ID_list),
-                config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts_{assay_suffix}.tsv"
+                config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts{assay_suffix}.tsv"
             output:
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom",
-                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv"
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom",
+                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv"
             params:
                 left_trunc = config["left_trunc"],
                 left_maxEE = config["left_maxEE"],
@@ -461,12 +461,12 @@ if config["data_type"] == "SE":
                 expand(config["raw_reads_dir"] + "{ID}" + config["raw_R1_suffix"], ID = sample_ID_list)
             output:
                 expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"], ID = sample_ID_list),
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom",
-                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs_{assay_suffix}.fasta",
-                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.tsv"
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom",
+                config["final_outputs_dir"] + config["output_prefix"] + f"ASVs{assay_suffix}.fasta",
+                config["final_outputs_dir"] + config["output_prefix"] + f"read-count-tracking{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+                config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.tsv"
             params:
                 left_trunc = config["left_trunc"],
                 left_maxEE = config["left_maxEE"],
@@ -577,7 +577,7 @@ if config["data_type"] == "SE":
             r1_html_files = expand(config["raw_reads_dir"] + "{ID}" + config["raw_R1_suffix"].rsplit(".", 2)[0] + "_fastqc.html", ID = sample_ID_list),
             config_file = "config/multiqc.config"
         output:
-            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc_{assay_suffix}_report.zip"
+            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"raw_multiqc{assay_suffix}_report.zip"
         benchmark:
             "benchmarks/raw_multiqc-benchmarks.tsv"
         shell:
@@ -622,7 +622,7 @@ if config["data_type"] == "SE":
             r1_html_files = expand(config["filtered_reads_dir"] + "{ID}" + config["filtered_R1_suffix"].rsplit(".", 2)[0] + "_fastqc.html", ID = sample_ID_list),
             config_file = "config/multiqc.config"
         output:
-            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc_{assay_suffix}_report.zip"
+            final_out_zip = config["fastqc_out_dir"] + config["output_prefix"] + f"filtered_multiqc{assay_suffix}_report.zip"
         benchmark:
             "benchmarks/filtered_multiqc-benchmarks.tsv"
 
@@ -639,11 +639,11 @@ rule r_visualizations:
     input:
         runsheet = config["runsheet"],
         sample_info = config["sample_info_file"],
-        counts = config["final_outputs_dir"] + config["output_prefix"] + f"counts_{assay_suffix}.tsv",
-        taxonomy = config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy_{assay_suffix}.tsv"
+        counts = config["final_outputs_dir"] + config["output_prefix"] + f"counts{assay_suffix}.tsv",
+        taxonomy = config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy{assay_suffix}.tsv"
     output:
         # Use completion flag file in place of plot outputs for variable plots
-        legend = config["plots_dir"] + config["output_prefix"] + f"color_legend_{assay_suffix}.png"
+        legend = config["plots_dir"] + config["output_prefix"] + f"color_legend{assay_suffix}.png"
     params:
         assay_suffix = assay_suffix,
         plots_dir = config["plots_dir"],
@@ -657,15 +657,15 @@ rule r_visualizations:
         "benchmarks/r-visualizations-benchmarks.tsv"
     shell:
         """
-        Rscript visualizations/Illumina-R-visualizations.R "{input.runsheet}" "{input.sample_info}" "{input.counts}" "{input.taxonomy}" "{params.assay_suffix}" "{params.plots_dir}" "{params.output_prefix}"  > {log} 2>&1
+        Rscript visualizations/Illumina-R-visualizations.R "{input.runsheet}" "{input.sample_info}" "{input.counts}" "{input.taxonomy}" "{params.plots_dir}" "{params.output_prefix}" "{params.assay_suffix}" > {log} 2>&1
         """
 
 
 rule zip_biom:
     input:
-        config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom"
+        config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom"
     output:
-        config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts_{assay_suffix}.biom.zip"
+        config["final_outputs_dir"] + config["output_prefix"] + f"taxonomy-and-counts{assay_suffix}.biom.zip"
     shell:
         """
         zip -j -q {output} {input} && rm {input}
@@ -678,8 +678,8 @@ rule combine_cutadapt_logs_and_summarize:
         counts = expand(config["trimmed_reads_dir"] + "{ID}-trimmed-counts.tsv", ID = sample_ID_list),
         logs = expand(config["trimmed_reads_dir"] + "{ID}-cutadapt.log", ID = sample_ID_list)
     output:
-        combined_log = config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt_{assay_suffix}.log",
-        combined_counts = config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts_{assay_suffix}.tsv"
+        combined_log = config["trimmed_reads_dir"] + config["output_prefix"] + f"cutadapt{assay_suffix}.log",
+        combined_counts = config["trimmed_reads_dir"] + config["output_prefix"] + f"trimmed-read-counts{assay_suffix}.tsv"
     benchmark:
         "benchmarks/combine_cutadapt_logs_and_summarize-benchmarks.tsv"
     shell: