app.ExPdPy
app.ExPdPy(
df=None,
cs_id=None,
ts_id=None,
df_def=None,
var_def=None,
config_list=None,
*,
title='ExPdPy - Explore your data!',
df_name=None,
components=None,
factor_cutoff=10,
export_nb_option=True,
save_settings_option=True,
store_encrypted=False,
key_phrase='What a wonderful key',
run=True,
**run_kwargs,
)
Launch (or build) the interactive ExPdPy app.
Parameters
| df |
Any |
A :class:pandas.DataFrame, a mapping of name->DataFrame, a list of DataFrames, or None to start with an upload dialog. |
None |
| cs_id |
Sequence[str] | str | None |
Cross-sectional / time-series identifier column name(s). Overridden by df_def. |
None |
| ts_id |
Sequence[str] | str | None |
Cross-sectional / time-series identifier column name(s). Overridden by df_def. |
None |
| df_def |
pd.DataFrame | None |
Optional variable-definition frame (columns var_name, var_def, type) used to identify the panel dimensions. |
None |
| var_def |
pd.DataFrame | None |
Optional analysis-sample variable definitions (advanced mode). Each var_def is a safe expression evaluated to build the analysis sample. |
None |
| config_list |
dict | None |
Optional startup configuration (see :func:expdpy.data.get_config). |
None |
| title |
str |
App title. |
'ExPdPy - Explore your data!' |
| df_name |
str | Sequence[str] | None |
Display name(s) for the provided sample(s). |
None |
| components |
Any |
Ordered list (or {name: bool} mapping) selecting which components to show. |
None |
| factor_cutoff |
int |
Numeric columns with at most this many unique values are treated as factors. |
10 |
| export_nb_option |
bool |
Enable the notebook-export and config save/load controls. |
True |
| save_settings_option |
bool |
Enable the notebook-export and config save/load controls. |
True |
| store_encrypted |
bool |
Encrypt saved configurations with a Fernet key derived from key_phrase. |
False |
| key_phrase |
bool |
Encrypt saved configurations with a Fernet key derived from key_phrase. |
False |
| run |
bool |
If True (default), start the app server; otherwise return the :class:shiny.App. |
True |
| **run_kwargs |
Any |
Forwarded to :meth:shiny.App.run (e.g. port, host, launch_browser). |
{} |
Returns
|
shiny.App |
The constructed app (also returned when run=True after the server stops). |