diff --git a/HISTORY.md b/HISTORY.md index f73bf92..b7c7290 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,10 @@ # History +1.5.1 (2024-02-01) +------------------ + +* Fixes #44, where `--use_raven` was not working (Flye would be used instead). Thanks @[wanyuac](https://github.com/wanyuac). + 1.5.0 (2023-11-21) ------------------ diff --git a/docs/requirements.txt b/docs/requirements.txt index 2e1b2ba..30bc2c1 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ Pygments==2.15.0 pymdown-extensions==10.0 -jinja2==3.0.3 +jinja2>=3.1.3 Markdown==3.3.7 diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index cf66129..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,35 +0,0 @@ -site_name: plassembler -site_url: "https://github.com/gbouras13/plassembler" -site_author: George Bouras -theme: - name: readthedocs - highlightjs: true - hljs_languages: - - yaml - - bash - - shell - - python -nav: - - ABOUT: - - Overview: index.md - - Why Use Plassembler?: reasons.md - - Method: method.md - - RUNNING: - - Install: install.md - - Usage: run.md - - OUTPUT: - - Output: output.md - - CITATION: - - Citation: citation.md - - BENCHMARKING: - - Fastq Preparation: fastqs.md - - Simulated Read Results: benchmarking_results_sim.md - - Real Read Results: benchmarking_results_real.md - - Flye Non Determinism: flye_non_determinism.md - - OTHER FEATURES: - - Quality Control: quality_control.md - - Multiple Chromosomes: multiple_chromosome.md - - Metagenomes: metagenomics.md - - Long v1.3.0: long.md - - Long v1.2.0 (superceded): long_old.md - diff --git a/pyproject.toml b/pyproject.toml index 4414504..8018178 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "plassembler" -version = "1.5.0" # change VERSION too +version = "1.5.1" # change VERSION too description = "Quickly and accurately assemble plasmids in hybrid sequenced bacterial isolates" authors = ["George Bouras "] license = "MIT" diff --git a/src/plassembler/__init__.py b/src/plassembler/__init__.py index 79462fa..21bb87a 100644 --- a/src/plassembler/__init__.py +++ b/src/plassembler/__init__.py @@ -400,6 +400,7 @@ def run( logger.info(f"--flye_assembly is {flye_assembly}") logger.info(f"--flye_info is {flye_info}") logger.info(f"--no_chromosome is {no_chromosome}") + logger.info(f"--use_raven is {use_raven}") logdir = Path(f"{outdir}/logs") # check deps @@ -455,8 +456,12 @@ def run( skip_assembly = True if skip_assembly is False: - logger.info("Running Flye.") - run_flye(outdir, threads, raw_flag, pacbio_model, logdir) + if use_raven is False: + logger.info("Running Flye.") + run_flye(outdir, threads, raw_flag, pacbio_model, logdir) + else: + logger.info("Running Raven.") + run_raven(outdir, threads, logdir) else: if flye_directory != "nothing": logger.info( diff --git a/src/plassembler/utils/CITATION b/src/plassembler/utils/CITATION index b2135fe..271f913 100644 --- a/src/plassembler/utils/CITATION +++ b/src/plassembler/utils/CITATION @@ -1,4 +1,3 @@ Please cite plassembler in your paper using: -Bouras, G., Sheppard A.E., Mallawaarachchi, V., Vreugde S. (2023) Plassembler https://github.com/gbouras13/plassembler. - +Bouras, G., Sheppard A.E., Mallawaarachchi, V., Vreugde S. (2023) Plassembler: an automated bacterial plasmid assembly tool, Bioinformatics, Volume 39, Issue 7, July 2023, btad409, https://doi.org/10.1093/bioinformatics/btad409 \ No newline at end of file diff --git a/src/plassembler/utils/VERSION b/src/plassembler/utils/VERSION index 3e1ad72..8e03717 100644 --- a/src/plassembler/utils/VERSION +++ b/src/plassembler/utils/VERSION @@ -1 +1 @@ -1.5.0 \ No newline at end of file +1.5.1 \ No newline at end of file diff --git a/tests/test_end_to_end.py b/tests/test_end_to_end.py index 0d5da4a..0af5ac7 100644 --- a/tests/test_end_to_end.py +++ b/tests/test_end_to_end.py @@ -90,6 +90,17 @@ def test_plassembler_case_1(self): exec_command(cmd) remove_directory(outdir) + def test_plassembler_case_1_use_raven(self): + """test plassembler run - chromosome only assembled with Flye, no plasmids - plasmids recovered from the short reads""" + longreads: Path = f"{end_to_end}/case1.fastq.gz" + s1: Path = f"{end_to_end}/input_R1.fastq.gz" + s2: Path = f"{end_to_end}/input_R2.fastq.gz" + chromosome = 50000 + outdir: Path = f"{end_to_end}/test_out" + cmd = f"plassembler run -l {longreads} -c {chromosome} -1 {s1} -2 {s2} -d {plassembler_db_dir} -o {outdir} -t 8 -f" + exec_command(cmd) + remove_directory(outdir) + def test_plassembler_case_2(self): with self.assertRaises(RuntimeError): """test plassembler run case 2 no chromosome assembled at all"""