Coverage for binette/config.py: 100%
46 statements
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-17 13:33 +0000
« prev ^ index » next coverage.py v7.17.3, created at 2026-11-17 13:33 +0000
1"""
2Module : config
3Description : Parameters of a Binette run and paths of its output files.
4Copyright : (c) Jean Mainguy
5License : GPL-3.0
6"""
8from dataclasses import dataclass
9from pathlib import Path
10from typing import Any
12from binette.checkpoint import CHECKPOINT_FILENAME
15@dataclass(frozen=True)
16class OutputPaths:
17 """Paths of the files and directories written by Binette in its output directory."""
19 outdir: Path
20 tmp_dir: Path
21 manifest: Path
22 faa_file: Path
23 coding_length_file: Path
24 diamond_result_file: Path
25 final_bin_report: Path
26 final_contig2bin_table: Path
27 original_bin_report_dir: Path
28 final_bins_dir: Path
29 index_to_contig_file: Path
30 all_bin_compo_file: Path
32 @classmethod
33 def from_outdir(cls, outdir: Path) -> "OutputPaths":
34 tmp_dir = outdir / "temporary_files"
35 return cls(
36 outdir=outdir,
37 tmp_dir=tmp_dir,
38 manifest=tmp_dir / CHECKPOINT_FILENAME,
39 faa_file=tmp_dir / "assembly_proteins.faa.gz",
40 coding_length_file=tmp_dir / "contig_coding_length.tsv.gz",
41 diamond_result_file=tmp_dir / "diamond_result.tsv.gz",
42 final_bin_report=outdir / "final_bins_quality_reports.tsv",
43 final_contig2bin_table=outdir / "final_contig_to_bin.tsv",
44 original_bin_report_dir=outdir / "input_bins_quality_reports",
45 final_bins_dir=outdir / "final_bins",
46 index_to_contig_file=outdir / "index_to_contig.tsv",
47 all_bin_compo_file=outdir / "all_bins_quality_reports.tsv",
48 )
51@dataclass(frozen=True)
52class RunConfig:
53 """Parameters of a Binette run."""
55 contigs: Path
56 bin_dirs: list[Path] | None = None
57 contig2bin_tables: list[Path] | None = None
58 proteins: Path | None = None
59 outdir: Path = Path("results")
60 prefix: str = "binette"
61 threads: int = 1
62 min_completeness: int = 40
63 max_contamination: int = 10
64 min_length: int = 200_000
65 max_length: int = 10_000_000
66 contamination_weight: float = 2.0
67 fasta_extensions: tuple[str, ...] = (".fasta", ".fa", ".fna")
68 checkm2_db: Path | None = None
69 low_mem: bool = False
70 resume: bool = True
71 force: bool = False
72 debug: bool = False
73 write_fasta_bins: bool = True
74 show_progress: bool = True
76 def selection_parameters(self) -> dict[str, Any]:
77 """
78 Parameters that change the final results without changing the intermediate
79 results (proteins, DIAMOND hits). Writing bin FASTA files is not one of them:
80 it is tracked separately.
81 """
82 return {
83 "min_completeness": self.min_completeness,
84 "max_contamination": self.max_contamination,
85 "min_length": self.min_length,
86 "max_length": self.max_length,
87 "contamination_weight": self.contamination_weight,
88 "prefix": self.prefix,
89 "debug": self.debug,
90 }