From 49be8b478a5d188f4a3045b4a9e9120650d42063 Mon Sep 17 00:00:00 2001 From: "Robert A. Petit III" Date: Thu, 8 Aug 2024 02:42:52 +0000 Subject: [PATCH] add mkdocstrings attempt 16 --- camlhmp/engines/blast.py | 2 +- docs/api/engines.md | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/camlhmp/engines/blast.py b/camlhmp/engines/blast.py index 3228787..c500d6f 100644 --- a/camlhmp/engines/blast.py +++ b/camlhmp/engines/blast.py @@ -23,7 +23,7 @@ def run_blast(engine: str, subject: str, query: str, min_pident: float, min_coverage: int) -> list: """ - Query sequences against a input subject using BLASTN. + Query sequences against a input subject using BLAST+. Args: engine (str): The BLAST engine to use diff --git a/docs/api/engines.md b/docs/api/engines.md index 1d1427e..807d615 100644 --- a/docs/api/engines.md +++ b/docs/api/engines.md @@ -2,4 +2,14 @@ ## Blast +### `camlhmp.engines.blast.run_blast` + ::: camlhmp.engines.blast.run_blast + +### `camlhmp.engines.blast.run_blastn` + +::: camlhmp.engines.blast.run_blastn + +### `camlhmp.engines.blast.run_tblastn` + +::: camlhmp.engines.blast.run_tblastn