Skip to content

Commit

Permalink
minor documentaion correction
Browse files Browse the repository at this point in the history
  • Loading branch information
raptor419 committed Aug 14, 2024
1 parent 2c281be commit 41ab62f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion STREAMLINE-Notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
"outputs": [],
"source": [
"# EDA outpute file controls (None, outputs all files)\n",
"exclude_eda_output = None # (None, or a list of 'str' values) with possible exclusions: ['describe','univariate_plots','correlation_plots']\n",
"exclude_eda_output = None # (None, or a list of 'str' values) with possible exclusions: ['describe_csv','univariate_plots','correlation_plots','correlation']\n",
"top_uni_features = 20 # (int) number of top significant features to report in notebook for univariate analysis\n",
"\n",
"# Data processing parameters (cleaning and feature engineering)\n",
Expand Down
9 changes: 5 additions & 4 deletions docs/source/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,12 +349,13 @@ This section will go into greater depth for each run parameter, primarily using
#### exclude_eda_output
* **Description:** allows users to exclude some of the outputs automatically generated by STREAMLINE during phase 1
* **Format:**
1. for notebook or config file modes: provide a (list) of valid options (str) , e.g. `['describe','univariate_plots','correlation_plots']`
2. for command line arguments: provide as a list of comma separated values with no spaces, e.g. `describe,univariate_plots,correlation_plots`
* **Values:** `None`, or [`'describe'`, `'univariate_plots'`, or `'correlation_plots'`] - provided in format above
* `describe` - don't run or output the set of standard pandas functions (i.e. `Describe()`, `Dtypes()`, and `nunique()`) as `.csv` files
1. for notebook or config file modes: provide a (list) of valid options (str) , e.g. `['describe_csv','univariate_plots','correlation_plots','correlation']`
2. for command line arguments: provide as a list of comma separated values with no spaces, e.g. `describe_describe,univariate_plots,correlation_plots,correlation`
* **Values:** `None`, or [`'describe_csv'`, `'univariate_plots'`, or `'correlation_plots'`] - provided in format above
* `describe_csv` - don't run or output the set of standard pandas functions (i.e. `Describe()`, `Dtypes()`, and `nunique()`) as `.csv` files
* `univariate_plots` - don't output individual univariate analysis plots illustrating features vs. outcome (by default STREAMLINE outputs these plots for any feature with a significant univariate association based on [`sig_cutoff`](#sig-cutoff))
* `correlation_plots` - don't output feature correlation heatmaps for the 'initial' or 'processed' data EDA
* `correlation` - don't run/make feature correlation matrices for the 'initial' or 'processed' data EDA, also switches off `correlation_plots`

#### top_uni_features
* **Description:** number of most significant features to report in the notebook and PDF summary
Expand Down

0 comments on commit 41ab62f

Please sign in to comment.