From a1a3a39b7b7fd2d2f694d3a41bfe7bcf72ff72c3 Mon Sep 17 00:00:00 2001
From: Arya Massarat <23412689+aryarm@users.noreply.github.com>
Date: Wed, 26 Jun 2024 14:40:46 -0700
Subject: [PATCH] docs: warn about scipy deprecation in dumpSTR (#221)

* warn about scipy deprecation in dumpSTR

* simplify warning in dumpSTR docs
---
 trtools/dumpSTR/README.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/trtools/dumpSTR/README.rst b/trtools/dumpSTR/README.rst
index f281a132..be4821cb 100644
--- 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
 --------------