# {py:mod}`ovo.app.components.descriptor_correlation`

```{py:module} ovo.app.components.descriptor_correlation
```

```{autodoc2-docstring} ovo.app.components.descriptor_correlation
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`correlation_clustermap <ovo.app.components.descriptor_correlation.correlation_clustermap>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_clustermap
    :summary:
    ```
* - {py:obj}`cluster_correlation_matrix <ovo.app.components.descriptor_correlation.cluster_correlation_matrix>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.cluster_correlation_matrix
    :summary:
    ```
* - {py:obj}`correlation_explorer <ovo.app.components.descriptor_correlation.correlation_explorer>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_explorer
    :summary:
    ```
* - {py:obj}`correlation_scatterplot_interactive <ovo.app.components.descriptor_correlation.correlation_scatterplot_interactive>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_scatterplot_interactive
    :summary:
    ```
* - {py:obj}`correlation_scatterplot <ovo.app.components.descriptor_correlation.correlation_scatterplot>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_scatterplot
    :summary:
    ```
* - {py:obj}`r2_score_pandas <ovo.app.components.descriptor_correlation.r2_score_pandas>`
  - ```{autodoc2-docstring} ovo.app.components.descriptor_correlation.r2_score_pandas
    :summary:
    ```
````

### API

````{py:function} correlation_clustermap(correlation_df: pandas.DataFrame, correlation_label: str)
:canonical: ovo.app.components.descriptor_correlation.correlation_clustermap

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_clustermap
```
````

````{py:function} cluster_correlation_matrix(correlation_df: pandas.DataFrame) -> pandas.DataFrame
:canonical: ovo.app.components.descriptor_correlation.cluster_correlation_matrix

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.cluster_correlation_matrix
```
````

````{py:function} correlation_explorer(correlation_df: pandas.DataFrame, df_combined: pandas.DataFrame, correlation_label: str, top_n: int = 10)
:canonical: ovo.app.components.descriptor_correlation.correlation_explorer

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_explorer
```
````

````{py:function} correlation_scatterplot_interactive(combined_df: pandas.DataFrame, corr_df: pandas.DataFrame, correlation_label: str)
:canonical: ovo.app.components.descriptor_correlation.correlation_scatterplot_interactive

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_scatterplot_interactive
```
````

````{py:function} correlation_scatterplot(combined_df: pandas.DataFrame, corr_df: pandas.DataFrame, correlation_label: str, x_descriptor: str, y_descriptor: str, key_suffix: str = '')
:canonical: ovo.app.components.descriptor_correlation.correlation_scatterplot

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.correlation_scatterplot
```
````

````{py:function} r2_score_pandas(y_true: pandas.Series, y_pred: pandas.Series) -> float
:canonical: ovo.app.components.descriptor_correlation.r2_score_pandas

```{autodoc2-docstring} ovo.app.components.descriptor_correlation.r2_score_pandas
```
````