documentation

hcs-t4sg · Dec 21, 2023 · 1eaf2c4 · 1eaf2c4
1 parent b853aab
commit 1eaf2c4
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/ersilia/core/tracking.py b/ersilia/core/tracking.py
@@ -119,9 +119,12 @@ 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. 
+# Stats function: 
     def stats(self, result):
+        """
+        This function calculates the basic statistics of the .csv output file from a model. This includes the mode (if applicable), 
+        minimum, maximum, and standard deviation. 
+        """
         dat = read_csv(result)
 
         # drop first two columns (key, input)