update styling stuff - collection, check func

Author: TomDonoghue

fooof/plts/settings.py

@@ -40,8 +40,13 @@
 # Custom style arguments are those that are custom-handled by the plot style function
 CUSTOM_STYLE_ARGS = ['title_fontsize', 'label_size', 'tick_labelsize',
                      'legend_size', 'legend_loc']
-STYLERS = ['axis_styler', 'line_styler', 'custom_styler']
-STYLE_ARGS = AXIS_STYLE_ARGS + LINE_STYLE_ARGS + CUSTOM_STYLE_ARGS + STYLERS
+
+# Define list of available style functions - these can also be replaced by arguments
+STYLERS = ['axis_styler', 'line_styler', 'collection_styler', 'custom_styler']
+
+# Collect the full set of possible style related input keyword arguments
+STYLE_ARGS = \
+    AXIS_STYLE_ARGS + LINE_STYLE_ARGS + COLLECTION_STYLE_ARGS + CUSTOM_STYLE_ARGS + STYLERS
 
 ## Define default values for plot aesthetics
 # These are all custom style arguments

fooof/plts/style.py

@@ -6,12 +6,22 @@
 import matplotlib.pyplot as plt
 
 from fooof.plts.settings import (AXIS_STYLE_ARGS, LINE_STYLE_ARGS, COLLECTION_STYLE_ARGS,
-                                 STYLE_ARGS, LABEL_SIZE, LEGEND_SIZE, LEGEND_LOC,
-                                 TICK_LABELSIZE, TITLE_FONTSIZE)
+                                 CUSTOM_STYLE_ARGS, STYLE_ARGS, TICK_LABELSIZE, TITLE_FONTSIZE,
+                                 LABEL_SIZE, LEGEND_SIZE, LEGEND_LOC)
 
 ###################################################################################################
 ###################################################################################################
 
+def check_style_options():
+    """Check the list of valid style arguments that can be passed into plot functions."""
+
+    print('Valid style arguments:')
+    for label, options in zip(['Axis', 'Line', 'Collection', 'Custom'],
+                              [AXIS_STYLE_ARGS, LINE_STYLE_ARGS,
+                              COLLECTION_STYLE_ARGS, CUSTOM_STYLE_ARGS]):
+        print('  ', label, '\t', ', '.join(options))
+
+
 def style_spectrum_plot(ax, log_freqs, log_powers, grid=True):
     """Apply style and aesthetics to a power spectrum plot.
 
@@ -229,9 +239,19 @@ def style_plot(func, *args, **kwargs):
     By default, this function applies styling with the `apply_style` function. Custom
     functions for applying style can be passed in using `apply_style` as a keyword argument.
 
-    The `apply_style` function calls sub-functions for applying style different plot elements,
-    and these sub-functions can be overridden by passing in alternatives for `axis_styler`,
-    `line_styler`, and `custom_styler`.
+    The `apply_style` function calls sub-functions for applying different plot elements, including:
+
+    - `axis_styler`: apply style options to an axis
+    - `line_styler`: applies style options to lines objects in a plot
+    - `collection_styler`: applies style options to collections objects in a plot
+    - `custom_style`: applies custom style options
+
+    Each of these sub-functions can be overridden by passing in alternatives.
+
+    To see the full set of style arguments that are supported, run the following code:
+
+    >>> from fooof.plts.style import check_style_options
+    >>> check_style_options()
     """
 
     @wraps(func)

fooof/tests/plts/test_styles.py

@@ -6,6 +6,10 @@
 ###################################################################################################
 ###################################################################################################
 
+def test_check_style_options():
+
+    check_style_options()
+
 def test_style_spectrum_plot(skip_if_no_mpl):
 
     # Create a dummy plot and style it