diff --git a/dabest/misc_tools.py b/dabest/misc_tools.py index f1adc6a2..512362a8 100644 --- a/dabest/misc_tools.py +++ b/dabest/misc_tools.py @@ -75,6 +75,14 @@ def get_varname(obj): return "" def get_params(effectsize_df, plot_kwargs): + """ + Parameters + ---------- + effectsize_df : object (Dataframe) + A `dabest` EffectSizeDataFrame object. + plot_kwargs : dict + Kwargs passed to the plot function. + """ face_color = plot_kwargs["face_color"] if plot_kwargs["face_color"] is None: @@ -122,11 +130,20 @@ def get_params(effectsize_df, plot_kwargs): show_pairs = False else: show_pairs = plot_kwargs["show_pairs"] + return (face_color, dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type) def get_kwargs(plot_kwargs, ytick_color): + """ + Parameters + ---------- + plot_kwargs : dict + Kwargs passed to the plot function. + ytick_color : str + Color of the yticks. + """ from .misc_tools import merge_two_dicts # Swarmplot kwargs diff --git a/nbs/API/misc_tools.ipynb b/nbs/API/misc_tools.ipynb index d4eb386c..06a79162 100644 --- a/nbs/API/misc_tools.ipynb +++ b/nbs/API/misc_tools.ipynb @@ -132,6 +132,14 @@ " return \"\"\n", "\n", "def get_params(effectsize_df, plot_kwargs):\n", + " \"\"\"\n", + " Parameters\n", + " ----------\n", + " effectsize_df : object (Dataframe)\n", + " A `dabest` EffectSizeDataFrame object.\n", + " plot_kwargs : dict\n", + " Kwargs passed to the plot function.\n", + " \"\"\"\n", " face_color = plot_kwargs[\"face_color\"]\n", "\n", " if plot_kwargs[\"face_color\"] is None:\n", @@ -179,11 +187,20 @@ " show_pairs = False\n", " else:\n", " show_pairs = plot_kwargs[\"show_pairs\"]\n", + " \n", "\n", " return (face_color, dabest_obj, plot_data, xvar, yvar, is_paired, effect_size, proportional, all_plot_groups, idx, \n", " show_delta2, show_mini_meta, float_contrast, show_pairs, effect_size_type)\n", "\n", "def get_kwargs(plot_kwargs, ytick_color):\n", + " \"\"\"\n", + " Parameters\n", + " ----------\n", + " plot_kwargs : dict\n", + " Kwargs passed to the plot function.\n", + " ytick_color : str\n", + " Color of the yticks.\n", + " \"\"\"\n", " from .misc_tools import merge_two_dicts\n", "\n", " # Swarmplot kwargs\n",