Merge branch 'master' into fix-heatmaps-always-created

seqnado/config.py

@@ -7,7 +7,6 @@
 template_dir = os.path.join(package_dir, "workflow/config")
 
 
-# Helper Functions
 def get_user_input(prompt, default=None, is_boolean=False, choices=None):
     while True:
         user_input = (
@@ -62,7 +61,7 @@ def setup_configuration(assay, genome, template_data):
         if genome in genome_values:
             genome_dict[genome] = {
                 "indices": genome_values[genome].get(
-                    "bt2_indices" if assay in ["chip", "atac"] else "star_indices", ""
+                    "star_indices" if assay in ["rna"] else "bt2_indices"
                 ),
                 "chromosome_sizes": genome_values[genome].get("chromosome_sizes", ""),
                 "gtf": genome_values[genome].get("gtf", ""),
@@ -143,19 +142,26 @@ def setup_configuration(assay, genome, template_data):
             )
 
     # Make bigwigs
-    template_data["make_bigwigs"] = get_user_input(
-        "Do you want to make bigwigs? (yes/no)", default="no", is_boolean=True
-    )
-    if template_data["make_bigwigs"]:
-        template_data["pileup_method"] = get_user_input(
-            "Pileup method:", default="deeptools", choices=["deeptools", "homer"]
-        )
-        template_data["scale"] = get_user_input(
-            "Scale bigwigs? (yes/no)", default="no", is_boolean=True
-        )
-        template_data["make_heatmaps"] = get_user_input(
-            "Do you want to make heatmaps? (yes/no)", default="no", is_boolean=True
+    if assay not in ["snp"]:
+        template_data["make_bigwigs"] = get_user_input(
+            "Do you want to make bigwigs? (yes/no)", default="no", is_boolean=True
         )
+        if template_data["make_bigwigs"]:
+            template_data["pileup_method"] = get_user_input(
+                "Pileup method:",
+                default="deeptools",
+                choices=["deeptools", "homer"],
+            )
+            template_data["scale"] = get_user_input(
+                "Scale bigwigs? (yes/no)", default="no", is_boolean=True
+            )
+            template_data["make_heatmaps"] = get_user_input(
+                "Do you want to make heatmaps? (yes/no)", default="no", is_boolean=True
+            )
+        else:
+            template_data["pileup_method"] = "False"
+            template_data["scale"] = "False"
+            template_data["make_heatmaps"] = "False"
 
     # Call peaks
     if assay in ["chip", "atac"]:
@@ -196,15 +202,47 @@ def setup_configuration(assay, genome, template_data):
         else "False"
     )
 
+    # SNP options
+    template_data["call_snps"] = (
+        get_user_input("Call SNPs? (yes/no)", default="no", is_boolean=True)
+        if assay == "snp"
+        else "False"
+    )
+    if assay == "snp" and template_data["call_snps"]:
+
+        template_data["snp_calling_method"] = get_user_input(
+            "SNP caller:",
+            default="bcftools",
+            choices=["bcftools", "deepvariant"],
+        )
+
+        template_data["fasta"] = get_user_input(
+            "Path to reference fasta:", default="path/to/reference.fasta"
+        )
+
+        template_data["fasta_index"] = get_user_input(
+            "Path to reference fasta index:", default="path/to/reference.fasta.fai"
+        )
+
+        template_data["snp_database"] = get_user_input(
+            "Path to SNP database:",
+            default="path/to/snp_database",
+        )
+    else:
+        template_data["snp_calling_method"] = "False"
+        template_data["fasta"] = "False"
+        template_data["fasta_index"] = "False"
+        template_data["snp_database"] = "False"
+
     # Make UCSC hub
     template_data["make_ucsc_hub"] = get_user_input(
         "Do you want to make a UCSC hub? (yes/no)", default="no", is_boolean=True
     )
 
     template_data["UCSC_hub_directory"] = (
-        get_user_input("UCSC hub directory:", default="/path/to/ucsc_hub/")
+        get_user_input("UCSC hub directory:", default="seqnado_output/hub/")
         if template_data["make_ucsc_hub"]
-        else "."
+        else "seqnado_output/hub/"
     )
     template_data["email"] = (
         get_user_input("What is your email address?", default=f"{username}@example.com")
@@ -218,7 +256,13 @@ def setup_configuration(assay, genome, template_data):
     )
 
     template_data["options"] = (
-        TOOL_OPTIONS if assay in ["chip", "atac"] else TOOL_OPTIONS_RNA
+        TOOL_OPTIONS
+        if assay in ["chip", "atac"]
+        else (
+            TOOL_OPTIONS_RNA
+            if assay == "rna"
+            else TOOL_OPTIONS_SNP if assay == "snp" else ""
+        )
     )
 
 
@@ -260,8 +304,8 @@ def setup_configuration(assay, genome, template_data):
     stringency: stringent
 
 heatmap:
-    options:
-    colormap: RdYlBu_r
+    options: -b 1000 -m 5000 -a 1000
+    colormap: RdYlBu_r 
 """
 
 TOOL_OPTIONS_RNA = """
@@ -295,8 +339,28 @@ def setup_configuration(assay, genome, template_data):
     bamcoverage: -bs 1 --normalizeUsing CPM
 
 heatmap:
+    options: -b 1000 -m 5000 -a 1000
+    colormap: RdYlBu_r 
+"""
+
+
+TOOL_OPTIONS_SNP = """
+trim_galore:
+    threads: 8
+    options: --2colour 20 
+
+bowtie2:
+    threads: 8
+    options:
+
+picard:
+    threads: 8
     options:
-    colormap: RdYlBu_r
+
+bcftools:
+    threads: 16
+    options:
+    
 """
 
 

seqnado/design.py

@@ -29,9 +29,13 @@ def is_path(path: Optional[Union[str, pathlib.Path]]) -> Optional[pathlib.Path]:
 
 class FastqFile(BaseModel):
     path: pathlib.Path
+    use_resolved_name: bool = False
 
     def model_post_init(self, *args):
-        self.path = pathlib.Path(self.path).resolve()
+        if self.use_resolved_name:
+            self.path = pathlib.Path(self.path).resolve()
+        else:
+            self.path = pathlib.Path(self.path).absolute()
 
         if not self.path.exists() or str(self.path) in ["-", ".", "", None]:
             raise FileNotFoundError(f"{self.path} does not exist.")
@@ -729,7 +733,7 @@ def from_design(
         subset_value: Optional[List[str]] = None,
         include_controls: bool = False,
     ):
-        
+
         if isinstance(design, Design):
             df = (
                 design.to_dataframe()
@@ -756,13 +760,11 @@ def from_design(
             )
             df = pd.concat([df_ip, df_control])
 
-
         if subset_value:
             df = df.query(f"{subset_column} in {subset_value}")
 
         samples = df.index.tolist()
 
-
         reference_sample = reference_sample or df.index[0]
 
         return cls(
@@ -874,7 +876,13 @@ class BigWigFiles(BaseModel):
     assay: Literal["ChIP", "ATAC", "RNA", "SNP"]
     names: List[str]
     pileup_method: Union[
-        Literal["deeptools", "homer"], List[Literal["deeptools", "homer"]]
+        Literal["deeptools", "homer", False],
+        List[
+            Literal[
+                "deeptools",
+                "homer",
+            ]
+        ],
     ] = None
     make_bigwigs: bool = False
     scale_method: Optional[Literal["cpm", "rpkm", "spikein", "csaw", "merged"]] = None
@@ -886,7 +894,9 @@ def model_post_init(self, __context: Any) -> None:
             self.pileup_method = [self.pileup_method]
 
         if self.include_unscaled and not self.scale_method:
-            self.scale_method = ["unscaled",]
+            self.scale_method = [
+                "unscaled",
+            ]
         elif self.include_unscaled and self.scale_method:
             self.scale_method = ["unscaled", self.scale_method]
         else:
@@ -953,6 +963,7 @@ def files(self) -> List[str]:
 class HeatmapFiles(BaseModel):
     assay: Literal["ChIP", "ATAC", "RNA", "SNP"]
     make_heatmaps: bool = False
+    make_heatmaps: bool = False
 
     @property
     def heatmap_files(self) -> List[str]:
@@ -968,6 +979,10 @@ def files(self) -> List[str]:
             return self.heatmap_files
         else:
             return []
+        if self.make_heatmaps:
+            return self.heatmap_files
+        else:
+            return []
 
 
 class HubFiles(BaseModel):
@@ -1021,9 +1036,11 @@ class Output(BaseModel):
     sample_names: List[str]
 
     make_bigwigs: bool = False
-    pileup_method: Optional[
-        Union[Literal["deeptools", "homer"], List[Literal["deeptools", "homer"]]]
+    pileup_method: Union[
+        Literal["deeptools", "homer", False],
+        List[Literal["deeptools", "homer"]],
     ] = None
+
     scale_method: Optional[Literal["cpm", "rpkm", "spikein", "csaw"]] = None
 
     make_heatmaps: bool = False
@@ -1236,8 +1253,10 @@ def peaks(self):
             s
             for s in self.sample_names
             if not any([c in s for c in self.control_names])
+            if not any([c in s for c in self.control_names])
         ]
 
+
         pcf_samples = PeakCallingFiles(
             assay=self.assay,
             names=ip_sample_names,
@@ -1284,3 +1303,55 @@ def files(self) -> List[str]:
                 files.extend(file_list)
 
         return files
+
+
+class SNPOutput(Output):
+    assay: Literal["SNP"]
+    call_snps: bool = False
+    sample_names: List[str]
+    make_ucsc_hub: bool = False
+    snp_calling_method: Optional[
+        Union[
+            Literal["bcftools", "deepvariant", False],
+            List[Literal["bcftools", "deepvariant"]],
+        ]
+    ] = None
+
+    @property
+    def design(self):
+        return ["seqnado_output/design.csv"]
+
+    @property
+    def snp_files(self) -> List[str]:
+        if self.call_snps:
+            return expand(
+                "seqnado_output/variant/{method}/{sample}.vcf.gz",
+                sample=self.sample_names,
+                method=self.snp_calling_method,
+            )
+        else:
+            return []
+
+    @computed_field
+    @property
+    def files(self) -> List[str]:
+        files = []
+        files.extend(
+            QCFiles(
+                assay=self.assay,
+                fastq_screen=self.fastq_screen,
+                library_complexity=self.library_complexity,
+            ).files
+        )
+
+        for file_list in (
+            self.snp_files,
+            self.design,
+        ):
+            if file_list:
+                files.extend(file_list)
+
+        if self.call_snps:
+            files.append(self.snp_files)
+
+        return files

seqnado/workflow/config/config.yaml.jinja

@@ -21,7 +21,6 @@ remove_blacklist: "{{remove_blacklist}}"
 blacklist: "{{blacklist}}"
 
 remove_pcr_duplicates_method: "{{remove_pcr_duplicates_method}}"
-library_complexity: "{{library_complexity}}"
 
 shift_atac_reads: "{{shift_atac_reads}}"
 
@@ -44,6 +43,11 @@ salmon_index: "{{salmon_index}}"
 
 run_deseq2: "{{run_deseq2}}"
 
+call_snps: "{{call_snps}}"
+snp_calling_method: "{{snp_calling_method}}"
+fasta: "{{fasta}}"
+fasta_index: "{{fasta_index}}"
+snp_database: "{{snp_database}}"
 
 make_ucsc_hub: "{{make_ucsc_hub}}"
 ucsc_hub_details:

seqnado/workflow/rules/common.smk

@@ -0,0 +1,8 @@
+
+rule save_design:
+    output:
+        "seqnado_output/design.csv",
+    container:
+        None
+    run:
+        DESIGN.to_dataframe().to_csv("seqnado_output/design.csv", index=False)

seqnado/workflow/rules/hub.smk

@@ -39,15 +39,6 @@ def get_hub_params(config):
     return hub_params
 
 
-rule save_design:
-    output:
-        "seqnado_output/design.csv",
-    container:
-        None
-    run:
-        DESIGN.to_dataframe().to_csv("seqnado_output/design.csv", index=False)
-
-
 rule validate_peaks:
     input:
         peaks=OUTPUT.peaks,