From b853aaba9454dc0a8807a397818f9a4bedb725ca Mon Sep 17 00:00:00 2001
From: sammy woo <sammywoo@sammys-Air.fios-router.home>
Date: Sun, 17 Dec 2023 05:32:55 -0500
Subject: [PATCH] statistics documentation

---
 ersilia/core/tracking.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/ersilia/core/tracking.py b/ersilia/core/tracking.py
index 0e4600748..f3774715e 100644
--- a/ersilia/core/tracking.py
+++ b/ersilia/core/tracking.py
@@ -119,6 +119,8 @@ def sample_df(self, df, num_rows, num_cols):
         """
         return df.sample(num_rows, axis=0).sample(num_cols, axis=1)
 
+# Stats function: calculates the basic statistics of the output file from a model. This includes the
+# mode (if applicable), minimum, maximum, and standard deviation. 
     def stats(self, result):
         dat = read_csv(result)