updated type hinting for core and some various docstrings

Author: Lblackhurst29

src/ethoscopy/analyse.py

@@ -41,6 +41,7 @@ def max_velocity_detector(data: pd.DataFrame,
         return None
 
     required_columns = ['t', 'x', 'y', 'w', 'h', 'phi', 'xy_dist_log10x1000']
+    # optional columns is a legacy of the R version. All ethoscope data should have it now
     optional_columns = ['has_interacted']
 
     # Prepare and bin the data

src/ethoscopy/behavpy_HMM_class.py

@@ -2,14 +2,20 @@
 
 class behavpy_HMM(behavpy_core):
     """
-    An inheritor class to aid with backwards compatability prior to version 2.0.0, so that old saved pickles of data can still be loaded
+    A compatibility class that inherits from behavpy_core to support loading data from versions prior to 2.0.0.
+    
+    This class allows loading of legacy pickled behavpy data files while maintaining core functionality.
+    Note that plotting methods are not available in the initial loaded state.
 
-    When old data is loaded it will only have the core functionalities  no plotting methods. The user must re-intiated either a plotly or
-    seaborn behavpy class with the data and metadata, i.e.
+    To access plotting functionality, the data must be re-instantiated with either the plotly or 
+    seaborn canvas option.
 
-    old_df = pd.read_pickle('path_to_data')
-    new_df = etho.behavpy(old_df, old_df.meta, check = True, canvas = 'seaborn')
-    
+    Both HMM and circadian classes have been folded into the one class as of 2.0.0.
+
+    Example
+    -------
+    >>> old_hmm_df = pd.read_pickle('path_to_data')
+    >>> new_df = etho.behavpy(old_df, old_df.meta, check=True, canvas='seaborn')
     """
     # set meta as permenant attribute
     _metadata = ['meta']

src/ethoscopy/behavpy_class.py

@@ -2,14 +2,18 @@
 
 class behavpy(behavpy_core):
     """
-    An inheritor class to aid with backwards compatability prior to version 2.0.0, so that old saved pickles of data can still be loaded
+    A compatibility class that inherits from behavpy_core to support loading data from versions prior to 2.0.0.
+    
+    This class allows loading of legacy pickled behavpy data files while maintaining core functionality.
+    Note that plotting methods are not available in the initial loaded state.
 
-    When old data is loaded it will only have the core functionalities  no plotting methods. The user must re-intiated either a plotly or
-    seaborn behavpy class with the data and metadata, i.e.
+    To access plotting functionality, the data must be re-instantiated with either the plotly or 
+    seaborn canvas option.
 
-    old_df = pd.read_pickle('path_to_data')
-    new_df = etho.behavpy(old_df, old_df.meta, check = True, canvas = 'seaborn')
-    
+    Example
+    -------
+    >>> old_df = pd.read_pickle('path_to_data')
+    >>> new_df = etho.behavpy(old_df, old_df.meta, check=True, canvas='seaborn')
     """
     # set meta as permenant attribute
     _metadata = ['meta']

src/ethoscopy/behavpy_core.py

@@ -16,7 +16,7 @@
 from ethoscopy.behavpy_core import behavpy_core
 from ethoscopy.misc.bootstrap_CI import bootstrap
 from ethoscopy.misc.general_functions import concat
-from ethoscopy.misc.hmm_functions import hmm_pct_transition, hmm_mean_length, hmm_pct_state
+from ethoscopy.misc.hmm_functions import hmm_pct_transition, hmm_mean_length #, hmm_pct_state
 
 class behavpy_draw(behavpy_core):
     """

src/ethoscopy/behavpy_draw.py

@@ -2,14 +2,20 @@
 
 class behavpy_periodogram(behavpy_core):
     """
-    An inheritor class to aid with backwards compatability prior to version 2.0.0, so that old saved pickles of data can still be loaded
+    A compatibility class that inherits from behavpy_core to support loading data from versions prior to 2.0.0.
+    
+    This class allows loading of legacy pickled behavpy data files while maintaining core functionality.
+    Note that plotting methods are not available in the initial loaded state.
 
-    When old data is loaded it will only have the core functionalities  no plotting methods. The user must re-intiated either a plotly or
-    seaborn behavpy class with the data and metadata, i.e.
+    To access plotting functionality, the data must be re-instantiated with either the plotly or 
+    seaborn canvas option.
 
-    old_df = pd.read_pickle('path_to_data')
-    new_df = etho.behavpy(old_df, old_df.meta, check = True, canvas = 'seaborn')
-    
+    Both HMM and circadian classes have been folded into the one class as of 2.0.0.
+
+    Example
+    -------
+    >>> old_hmm_df = pd.read_pickle('path_to_data')
+    >>> new_df = etho.behavpy(old_df, old_df.meta, check=True, canvas='seaborn')
     """
     # set meta as permenant attribute
     _metadata = ['meta']

src/ethoscopy/behavpy_periodogram_class.py

@@ -18,7 +18,7 @@ def validate_datetime(data: pd.DataFrame) -> pd.DataFrame:
         ValueError: If date format cannot be converted to YYYY-MM-DD
     """
     # Define supported date formats
-    date_formats = ['%Y-%m-%d', '%d-%m-%Y', '%d/%m/%Y']
+    date_formats = ['%Y-%m-%d', '%d-%m-%Y', '%d/%m/%Y', '%Y/%d/%m']
 
     def convert_date(date_str, row_idx):
         for fmt in date_formats: