Update VolcanoPlot props (#554)

* Update volcanoplot args * Update bundle * Remove default legend * Adding x_axis and y_axis props * Added percy snapshot for layout props * Added convert canvas arg * Temporarily remove snapshot * Added default Title and Legend * Linting fix * Another linting fix * Enable percy snapshot * Updating snapshot * Linting * Changing variable name * Testing alternative snapshot * Remove unnecessary args * Update test params * Fixed bundle.map dynamic * Move defaults to layout * Moved suggested keys in docstring * Removing update_axes * Removed explicit title arg
plotly · Apr 15, 2021 · ab64f01 · ab64f01
1 parent 6ebfd28
commit ab64f01
Show file tree

Hide file tree

Showing 9 changed files with 103 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 * [#543](https://github.com/plotly/dash-bio/pull/543) Added Dash Pileup component.
 * [#547](https://github.com/plotly/dash-bio/pull/547) Added shapes and isosurfaces props to 3dMoleculeViewer to enable rendering additional features on the molecule.
 * [#553](https://github.com/plotly/dash-bio/pull/553) Added source mapping.
+* [#554](https://github.com/plotly/dash-bio/pull/554) Added additional props and arbitrary layout arguments to VolcanoPlot.
 
 
 ## [0.6.1] - 2021-02-15

diff --git a/R/internal.R b/R/internal.R
@@ -154,7 +154,7 @@ version = "0.6.2", src = list(href = NULL,
 file = "deps"), meta = NULL,
 script = 'bundle.js.map',
 stylesheet = NULL, head = NULL, attachment = NULL, package = "dashBio",
-all_files = FALSE), class = "html_dependency"),
+all_files = FALSE, dynamic = TRUE), class = "html_dependency"),
 `dash_bio-shared` = structure(list(name = "dash_bio-shared",
 version = "0.6.2", src = list(href = NULL,
 file = "deps"), meta = NULL,

diff --git a/dash_bio/__init__.py b/dash_bio/__init__.py
@@ -84,7 +84,8 @@
             'https://unpkg.com/dash-bio@{}'
             '/' + package_name + '/bundle.js.map'
         ).format(__version__),
-        'namespace': package_name
+        'namespace': package_name,
+        'dynamic': True
     }
 ])
 

diff --git a/dash_bio/bundle.js b/dash_bio/bundle.js
diff --git a/dash_bio/bundle.js.map b/dash_bio/bundle.js.map
diff --git a/dash_bio/component_factory/_volcano.py b/dash_bio/component_factory/_volcano.py
@@ -21,7 +21,6 @@ def VolcanoPlot(
         gene='GENE',
         annotation=None,
         logp=True,
-        title='Volcano Plot',
         xlabel=None,
         ylabel='-log10(p)',
         point_size=5,
@@ -33,7 +32,8 @@ def VolcanoPlot(
         genomewideline_color='grey',
         genomewideline_width=1,
         highlight=True,
-        highlight_color="red"
+        highlight_color="red",
+        **kwargs
 ):
     """Return a Dash Bio VolcanoPlot figure.
 
@@ -72,7 +72,6 @@ def VolcanoPlot(
     plotting the raw value could be useful for other genome-wide plots
     (e.g., peak heights, Bayes factors, test statistics, and other
     "scores").
-- title (string; default 'Volcano Plot'): Title of the graph.
 - xlabel (string; optional): Label of the x axis.
 - ylabel (string; default '-log10(p)'): Label of the y axis.
 - point_size (number; default 5): Size of the points of the Scatter
@@ -110,11 +109,29 @@ def VolcanoPlot(
     dataframe = pd.DataFrame(
         np.random.randint(0,100,size=(100, 2)),
         columns=['P', 'EFFECTSIZE'])
-    fig = create_volcano(dataframe, title='XYZ Volcano plot')
+    fig = create_volcano(dataframe, title=dict(text='XYZ Volcano plot'))
 
     plotly.offline.plot(fig, image='png')
     '''
-
+- Additional keys (misc.): Arbitrary arguments can be passed to modify the
+    Layout and styling of the graph. A full reference of acceptable args is
+    available [here](https://plotly.com/python-api-reference/generated/plotly.graph_objects
+    .Layout.html).
+
+    Some commonly used layout keys are:
+    - title (dict: optional): Dict with compatible properties for the title of
+        the figure layout.
+    - xaxis (dict: optional): Dict with compatible properties for the x-axis of
+        the figure layout.
+    - yaxis (dict: optional): Dict with compatible properties for the y-axis of
+        the figure layout.
+    - height (number; optional): Sets the plot's height (in px).
+    - width (number; optional): Sets the plot's width (in px).
+    - margin (dict | plotly.graph_objects.layout.Margin instance): A dict or Margin
+        instance that sets the separation between the main plotting space and
+        the outside of the figure.
+    - legend (dict | plotly.graph_objects.layout.Legend instance): A dict or Legend
+        instance with compatible properties.
     """
 
     vp = _VolcanoPlot(
@@ -128,7 +145,6 @@ def VolcanoPlot(
     )
 
     return vp.figure(
-        title=title,
         xlabel=xlabel,
         ylabel=ylabel,
         point_size=point_size,
@@ -140,7 +156,8 @@ def VolcanoPlot(
         genomewideline_color=genomewideline_color,
         genomewideline_width=genomewideline_width,
         highlight=highlight,
-        highlight_color=highlight_color
+        highlight_color=highlight_color,
+        **kwargs
     )
 
 
@@ -274,7 +291,6 @@ def __init__(
 
     def figure(
             self,
-            title='Volcano Plot',
             xlabel=None,
             ylabel='-log10(p)',
             point_size=5,
@@ -287,14 +303,13 @@ def figure(
             genomewideline_width=1,
             highlight=True,
             highlight_color='red',
+            **kwargs
     ):
         """Return a figure object compatible with plotly.graph_objects.
 
         Keyword arguments:
-    - title (string; default 'Volcano Plot'): Title of the
-        graph.
-    - xlabel (string; optional): Label of the x axis.
-    - ylabel (string; default '-log10(p)'): Label of the y axis.
+    - xlabel (string; optional): Label of the x-axis.
+    - ylabel (string; default '-log10(p)'): Label of the y-axis.
     - point_size (number; default 5): Size of the points of the scatter
       plot.
     - col (string; optional): Color of the points of the Scatter plot. Can
@@ -322,6 +337,25 @@ def figure(
     - highlight_color (string; default 'red'): Color of the data points
         highlighted because considered significant. Can be in any color
         format accepted by plotly.graph_objects.
+    - Additional keys (misc.): Arbitrary arguments can be passed to modify the
+        Layout and styling of the graph. A full reference of acceptable args is
+        available [here](https://plotly.com/python-api-reference/generated/plotly.graph_objects
+        .Layout.html).
+
+        Some commonly used layout keys are:
+        - title (dict: optional): Dict with compatible properties for the title of
+            the figure layout.
+        - xaxis (dict: optional): Dict with compatible properties for the x-axis of
+            the figure layout.
+        - yaxis (dict: optional): Dict with compatible properties for the y-axis of
+            the figure layout.
+        - height (number; optional): Sets the plot's height (in px).
+        - width (number; optional): Sets the plot's width (in px).
+        - margin (dict | plotly.graph_objects.layout.Margin instance): A dict or Margin
+            instance that sets the separation between the main plotting space and
+            the outside of the figure.
+        - legend (dict | plotly.graph_objects.layout.Legend instance): A dict or Legend
+            instance with compatible properties.
         """
 
         if xlabel is None:
@@ -355,13 +389,18 @@ def figure(
             col = 'black'
 
         layout = go.Layout(
-            title=title,
+            title={'text': 'Volcano Plot',
+                   'font': {'family': 'sans-serif', 'size': 20},
+                   'x': 0.5,
+                   'xanchor': 'right',
+                   'yanchor': 'top'
+                   },
             hovermode='closest',
-            legend={
-                'x': 0.85,
-                'y': 0.1,
-                'bgcolor': '#f2f5fa'
-            },
+            legend={'bgcolor': '#ebf1fa',
+                    'yanchor': 'top',
+                    'x': 1.01,
+                    "font": {"family": "sans-serif"}
+                    },
             xaxis={
                 'title': xlabel,
                 'zeroline': False,
@@ -373,6 +412,8 @@ def figure(
             }
         )
 
+        layout.update(**kwargs)
+
         data_to_plot = []  # To contain the data traces
         tmp = pd.DataFrame()  # Empty DataFrame to contain the highlighted data
 

diff --git a/inst/deps/bundle.js b/inst/deps/bundle.js
diff --git a/inst/deps/bundle.js.map b/inst/deps/bundle.js.map
diff --git a/tests/integration/test_volcano_plot.py b/tests/integration/test_volcano_plot.py
@@ -1,12 +1,13 @@
 import json
 import pandas
 
+from common_features import nested_component_layout, \
+    nested_component_app_callback
+
 import dash
 import dash_html_components as html
 import dash_bio
 
-from common_features import nested_component_layout, \
-    nested_component_app_callback
 
 _data = None
 
@@ -129,3 +130,36 @@ def test_dbvp005_effect_size_line_value(dash_duo):
         data_prop_name='dataframe',
         take_snapshot=True
     )
+
+
+def test_dbvp006_test_layout_props(dash_duo):
+    app = dash.Dash(__name__)
+
+    app.layout = html.Div(nested_component_layout(
+        dash_bio.VolcanoPlot(
+            dataframe=_data,
+            width=600,
+            legend={
+                'x': 0.85,
+                'orientation': 'h',
+                'yanchor': 'bottom',
+                'y': 1.02,
+                'bgcolor': '#f2f5fa'
+            },
+            xaxis={"color": "red"},
+            yaxis={"color": "blue"},
+            template="simple_white",
+        )
+    ))
+
+    nested_component_app_callback(
+        app,
+        dash_duo,
+        component=dash_bio.VolcanoPlot,
+        component_data=_data,
+        test_prop_name='plot_bgcolor',
+        test_prop_value='pink',
+        prop_value_type='string',
+        data_prop_name='dataframe',
+        take_snapshot=True
+    )