statistics documentation

hcs-t4sg · Dec 17, 2023 · b853aab · b853aab
1 parent aeae5ae
commit b853aab
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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)