From b2ceea9f8af58ce70c65d2312c821c2bf4275d37 Mon Sep 17 00:00:00 2001 From: markus Date: Tue, 9 Feb 2021 13:47:21 +0100 Subject: [PATCH] document display_original_vs_english --- cara/montecarlo.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/cara/montecarlo.py b/cara/montecarlo.py index c4729298..255e82fe 100644 --- a/cara/montecarlo.py +++ b/cara/montecarlo.py @@ -521,7 +521,16 @@ def buaonanno_exposure_model(): ) -def display_original_vs_english(original_pi: np.ndarray, english_pi: np.ndarray): +def display_original_vs_english(original_pi: np.ndarray, english_pi: np.ndarray) -> None: + """ + Displays a violin-plot of the distributions of probabilities of infection of the original and english virus variant + respectively + :param original_pi: A numpy-array of percentages [0, 100] representing probabilities of infection associated with + the original variant + :param english_pi: A numpy-array of percentages [0, 100] representing probabilities of infection associated with + the english variant + :return: Nothing, a violin-plot is displayed + """ print(f"\nMedian(P_i) - Original: {'{:.2f}'.format(np.median(original_pi))}%\n" f"Mean(P_i) - Original: {'{:.2f}'.format(np.mean(original_pi))}%\n\n" f"Median(P_i) - English: {'{:.2f}'.format(np.median(english_pi))}%\n"