docs: warn about scipy deprecation in dumpSTR (#221)

* warn about scipy deprecation in dumpSTR * simplify warning in dumpSTR docs
gymrek-lab · Jun 26, 2024 · a1a3a39 · a1a3a39
1 parent dc27638
commit a1a3a39
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/trtools/dumpSTR/README.rst b/trtools/dumpSTR/README.rst
@@ -37,6 +37,9 @@ The available filters are described below.
 
 See `Example Commands`_ for running dumpSTR on different supported TR genotypers using example VCFs in this repository.
 
+.. warning::
+  :code:`dumpSTR<6.0.0` and :code:`scipy>=1.12.0` are incompatible. You should update to a newer version of TRTools if you encounter an error indicating that :code:`scipy.stats.binom_test` has been deprecated.
+
 Filter options
 --------------