Skip to content

Commit f78857b

Browse files
authored
docs:bio: drop documentation for volcanoplot
1 parent f4ff867 commit f78857b

File tree

1 file changed

+0
-51
lines changed

1 file changed

+0
-51
lines changed

doc/python/bio-volcano-plot.md

-51
Original file line numberDiff line numberDiff line change
@@ -77,54 +77,3 @@ from IPython.display import IFrame
7777
snippet_url = 'https://dash-gallery.plotly.host/python-docs-dash-snippets/'
7878
IFrame(snippet_url + 'bio-volcano', width='100%', height=630)
7979
```
80-
81-
## VolcanoPlot Properties
82-
> Access this documentation in your Python terminal with:
83-
>
84-
> ```>>> help(dash_bio.VolcanoPlot)```
85-
>
86-
> Our recommended IDE for writing Dash apps is Dash Enterprise's Data Science Workspaces, which has typeahead support for Dash Component Properties. Find out if your company is using Dash Enterprise.
87-
88-
**dataframe** (_dataframe_; required): A pandas dataframe which must contain at least the following two columns: - a numeric quantity to plot such as a p-value or zscore - a numeric quantity measuring the strength of association, typically an odds ratio, regression coefficient, or log fold change. Here, it is referred to as `effect_size`.
89-
90-
**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.
91-
92-
**annotation** (_string_; optional): A string denoting the column to use as annotations. This could be any annotation information that you want to include in the plot (e.g., zscore, effect size, minor allele frequency).
93-
94-
**col** (_string_; optional): Color of the points of the Scatter plot. Can be in any color format accepted by plotly.graph_objects.
95-
96-
**effect_size** (_string_; default `'EFFECTSIZE'`): A string denoting the column name for the effect size. This column must be numeric and must not contain missing nor NaN values.
97-
98-
**effect_size_line** (_bool_ | list; default `[-1, 1]`): A boolean which must be either False to deactivate the option, or a list/array containing the upper and lower bounds of the effect size values. Significant data points will have lower values than the lower bound, or higher values than the higher bound. Keeping the default value will result in assigning the list [-1, 1] to the argument.
99-
100-
**effect_size_line_color** (_string_; default `'grey'`): Color of the effect size lines.
101-
102-
**effect_size_line_width** (_number_; default `2`): Width of the effect size lines.
103-
104-
**gene** (_string_; default `GENE`): A string denoting the column name for the GENE names. More generally, this could be any annotation information that should be included in the plot.
105-
106-
**genomewideline_value** (_bool_ | number; default `-log10(5e-8)`): A boolean which must be either False to deactivate the option, or a numerical value corresponding to the p-value above which the data points are considered significant.
107-
108-
**genomewideline_color** (_string_; default `'red'`): Color of the genome-wide line. Can be in any color format accepted by plotly.graph_objects.
109-
110-
**genomewideline_width** (_number_; default `1`): Width of the genome-wide line.
111-
112-
**highlight** (_bool_; default `True`): Whether the data points considered significant should be highlighted or not.
113-
114-
**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. # ... Example 1: Random Volcano Plot ''' dataframe = pd.DataFrame( np.random.randint(0,100,size=(100, 2)), columns=['P', 'EFFECTSIZE']) fig = create_volcano(dataframe, title=dict(text='XYZ Volcano plot')) plotly.offline.plot(fig, image='png') '''
115-
116-
**logp** (_bool_; default `True`): If True, the -log10 of the p-value is plotted. It isn't very useful to plot raw p-values; however, plotting the raw value could be useful for other genome-wide plots (e.g., peak heights, Bayes factors, test statistics, and other "scores").
117-
118-
**p (_string_;** default `'P'`): A string denoting the column name for the float quantity to be plotted on the y-axis. This column must be numeric. It does not have to be a p-value. It can be any numeric quantity such as peak heights, Bayes factors, test statistics. If it is not a p-value, make sure to set logp = False.
119-
120-
**point_size** (_number_; default `5`): Size of the points of the Scatter plot.
121-
122-
**snp** (_string_; default `'SNP'`): A string denoting the column name for the SNP names (e.g., rs number). More generally, this column could be anything that identifies each point being plotted. For example, in an Epigenomewide association study (EWAS), this could be the probe name or cg number. This column should be a character. This argument is optional, however it is necessary to specify it if you want to highlight points on the plot using the highlight argument in the figure method.
123-
124-
**xlabel** (_string_; optional): Label of the x axis.
125-
126-
**ylabel** (_string_; default `'-log10(p)'`): Label of the y axis.
127-
128-
```python
129-
130-
```

0 commit comments

Comments
 (0)