eda-toolkit 0.0.1a0__tar.gz

eda_toolkit-0.0.1a0/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 [Leonid Shpaner, Oscar Gil]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

eda_toolkit-0.0.1a0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: eda_toolkit
+Version: 0.0.1a0
+Summary: A Python library for EDA (directory management, some data preprocessing, reporting, visualizations, and more)
+Author: Leonid Shpaner, Oscar Gil
+Author-email: lshpaner@ucla.edu
+Project-URL: Leonid Shpaner Website, https://www.leonshpaner.com
+Project-URL: Oscar Gil Website, https://www.oscargildata.com
+Project-URL: Source Code, https://github.com/lshpaner/eda_kit/
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: numpy>=1.21.6
+Requires-Dist: pandas>=1.3.5
+Requires-Dist: matplotlib>=3.5.3
+Requires-Dist: seaborn>=0.12.2
+Requires-Dist: xlsxwriter>=3.2.0
+
+# EDA Kit
+Welcome to EDA Kit, a collection of utility functions designed to streamline your exploratory data analysis (EDA) tasks. This repository offers tools for directory management, data preprocessing, reporting, visualization, and more, helping you efficiently handle various aspects of data manipulation and analysis.
+
+
+## Prerequisites
+
+Before you install `eda_kit`, ensure your system meets the following requirements:
+
+- `Python`: Version `3.7.4` or higher is required to run `eda_kit`.
+
+
+Additionally, `eda_kit` depends on the following packages, which will be automatically installed when you install `eda_kit`:
+
+- `numpy`: Version 1.21.6 or higher
+- `pandas`: Version 1.3.5 or higher
+- `matplotlib`: version 3.5.3 or higher
+- `seaborn`: version 0.12.2 or higher
+- `jinja2`: Version 3.1.4 or higher
+- `xlsxwriter`: version 3.2.0 or higher
+
+
+## Installation
+
+You can install `eda_kit` directly from PyPI:
+
+```bash
+pip install eda_kit
+```
+
+## 🌐 Authors' Websites
+
+https://www.leonshpaner.com  
+https://www.oscargildata.com 
+
+
+## ⚖️ License
+
+`eda_kit` is distributed under the MIT License. See [LICENSE](https://github.com/lshpaner/eda_kit/blob/readme/LICENSE.md) for more information.
+
+
+## Support
+
+If you have any questions or issues with `eda_kit`, please open an issue on this GitHub repository.
+
+
+
+

eda_toolkit-0.0.1a0/README.md

@@ -0,0 +1,250 @@
+# EDA Kit
+Welcome to EDA Kit, a collection of utility functions designed to streamline your exploratory data analysis (EDA) tasks. This repository offers tools for directory management, data preprocessing, reporting, visualization, and more, helping you efficiently handle various aspects of data manipulation and analysis.
+
+---
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Overview](#overview)
+3. [Functions](#functions)  
+    a. [Path Directories](#path-directories)  
+    b. [Generate Random IDs](#generate-random-ids)  
+    c. [Trailing Periods](#trailing-periods)  
+    d. [Standardized Dates](#standardized-dates)  
+    e. [Data Types Reports](#data-types-reports)  
+    f. [DataFrame Columns Analysis](#dataframe-columns-analysis)  
+    g. [Summarize All Combinations](#summarize-all-combinations)  
+    h. [Save DataFrames to Excel](#save-dataframes-to-excel)  
+    i. [Contingency Table](#contingency-table)  
+    j. [Highlight DataFrame Tables](#highlight-dataframe-tables)  
+    k. [KDE Distribution Plots](#kde-distribution-plots)  
+    l. [Stacked Bar Plots with Crosstab Options](#stacked-bar-plots-with-crosstab-options)  
+    m. [Filtered DataFrame Plots](#filtered-dataframe-plots)  
+    n. [Metrics Box and Violin Plots](#metrics-box-and-violin-plots)  
+4. [Usage](#usage)
+5. [Contributing](#contributing)
+6. [License](#license)
+
+---
+
+## Installation
+Clone the repository and install the necessary dependencies:
+
+```bash
+git clone https://github.com/your_username/eda_kit.git
+cd eda_kit
+pip install -r requirements.txt
+```
+
+## Overview
+EDA Kit is a comprehensive toolkit for data analysts and data scientists alike. It provides a suite of functions to handle common EDA tasks, making your workflow more efficient and organized. The toolkit covers everything from directory management and ID generation to complex visualizations and data reporting.
+
+## Functions
+### Path Directories
+`ensure_directory(path)`: ensures that the specified directory exists; if not, it creates it.
+
+### Generate Random IDs
+`add_ids(df, column_name="Patient_ID", seed=None)`: adds a column of unique, 9-digit IDs to a DataFrame.
+
+### Trailing Periods
+`strip_trailing_period(df, column_name)`: strips trailing periods from floats in a specified column of a DataFrame.
+
+### Standardized Dates
+`parse_date_with_rule(date_str)`: parses and standardizes date strings to the ISO 8601 format (YYYY-MM-DD).
+
+### Data Types Reports
+`data_types(df)`: provides a report on every column in the DataFrame, showing column names, data types, number of nulls, and percentage of nulls.
+
+### DataFrame Columns Analysis
+`dataframe_columns(df)`: analyzes DataFrame columns for dtype, null counts, max unique values, and their percentages.
+
+### Summarize All Combinations
+`summarize_all_combinations(df, variables, data_path, data_name, min_length=2)`: generates summary tables for all possible combinations of specified variables in the DataFrame and saves them to an Excel file.
+
+### Save DataFrames to Excel
+`save_dataframes_to_excel(file_path, df_dict, decimal_places=2)`: saves multiple DataFrames to separate sheets in an Excel file with customized formatting.
+
+### Contingency Table
+`contingency_table(df, col1, col2, SortBy)`: creates a contingency table from one or two columns in a DataFrame, with sorting options.
+
+### Highlight DataFrame Tables
+`highlight_columns(df, columns, color="yellow")`: highlights specific columns in a DataFrame with a specified background color.
+
+### KDE Distribution Plots
+
+```python
+
+kde_distributions(
+    df,
+    dist_list,
+    x,
+    y,
+    kde=True,
+    n_rows=1,
+    n_cols=1,
+    w_pad=1.0,
+    h_pad=1.0,
+    text_wrap=50,
+    image_path_png=None,
+    image_path_svg=None,
+    image_filename=None,
+    bbox_inches=None,
+    vars_of_interest=None,
+    single_var_image_path_png=None,
+    single_var_image_path_svg=None,
+    single_var_image_filename=None,
+    y_axis="count",
+    plot_type="both",
+)
+
+```
+Generates KDE or histogram distribution plots for specified columns in a DataFrame.
+
+### Stacked Bar Plots with Crosstab Options
+
+```python
+stacked_crosstab_plot(
+    df,
+    col,
+    func_col,
+    legend_labels_list,
+    title,
+    kind="bar",
+    width=0.9,
+    rot=0,
+    custom_order=None,
+    image_path_png=None,
+    image_path_svg=None,
+    save_formats=None,
+    color=None,
+    output="both",
+    return_dict=False,
+    x=None,
+    y=None,
+    p=None,
+    file_prefix=None,
+    logscale=False,
+    plot_type="both",
+    show_legend=True,
+)
+```
+
+Generates stacked bar plots and crosstabs for specified columns.
+
+### Filtered DataFrame Plots
+```python
+
+plot_filtered_dataframes(
+    df,
+    col,
+    func_col,
+    legend_labels_list,
+    title,
+    file_prefix,
+    condition_col=None,
+    condition_val=1,
+    x=12,
+    y=8,
+    p=10,
+    kind="bar",
+    width=0.9,
+    rot=0,
+    image_path_png=None,
+    image_path_svg=None,
+    save_formats=["png", "svg"],
+    color=None,
+    output="both",
+    return_dict=True,
+    logscale=True,
+    plot_type="both",
+    show_legend=True,
+)
+
+```
+Filters the DataFrame based on a specified condition and generates plots and crosstabs.
+
+### Metrics Box and Violin Plots
+
+```python
+metrics_box_violin(
+    df,
+    metrics_list,
+    metrics_boxplot_comp,
+    n_rows,
+    n_cols,
+    image_path_png,
+    image_path_svg,
+    save_individual=True,
+    save_grid=True,
+    save_both=False,
+    show_legend=True,
+    plot_type="boxplot",
+)
+```
+Creates and saves individual boxplots or violin plots, or an entire grid of plots for given metrics and comparisons.
+
+## Usage
+
+### Import the module and functions
+
+```python
+import pandas as pd
+import numpy as np
+import random
+from itertools import combinations
+import datetime
+from IPython.display import display
+import matplotlib.pyplot as plt
+import seaborn as sns
+import textwrap
+import os
+import warnings
+# Import the utility functions from EDA Kit
+from eda_kit import (
+    ensure_directory,
+    add_ids,
+    strip_trailing_period,
+    parse_date_with_rule,
+    data_types,
+    dataframe_columns,
+    summarize_all_combinations,
+    save_dataframes_to_excel,
+    contingency_table,
+    highlight_columns,
+    kde_distributions,
+    stacked_crosstab_plot,
+    plot_filtered_dataframes,
+    metrics_box_violin,
+)
+```
+
+### Use the functions as needed in your data analysis workflow
+
+
+```python
+# Example usage of ensure_directory function
+ensure_directory('path/to/your/directory')
+```
+
+
+### Example usage of add_ids function
+```python
+df = pd.DataFrame({'data': range(10)})
+df_with_ids = add_ids(df)
+print(df_with_ids)
+```
+
+## Contributing
+We welcome contributions! If you have suggestions or improvements, please submit an issue or pull request. Follow the standard GitHub flow for contributing.
+
+1. Fork the repository
+2. Create a new branch (`git checkout -b feature-branch`)
+3. Make your changes
+4. Commit your changes (`git commit -am 'Add new feature'`)
+5. Push to the branch (`git push origin feature-branch`)
+6. Create a new Pull Request
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/lshpaner/eda_kit/blob/readme/LICENSE.md) file for details.
+
+For more detailed documentation, refer to the docstrings within each function.

eda_toolkit-0.0.1a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

eda_toolkit-0.0.1a0/setup.py

@@ -0,0 +1,37 @@
+from setuptools import setup, find_packages
+import codecs
+
+with codecs.open("README_min.md", "r", "utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="eda_toolkit",
+    version="0.0.1a",
+    author="Leonid Shpaner, Oscar Gil",
+    author_email="lshpaner@ucla.edu",
+    description="A Python library for EDA (directory management, some data preprocessing, reporting, visualizations, and more)",
+    long_description=long_description,
+    long_description_content_type="text/markdown",  # Type of the long description
+    package_dir={"": "src"},  # Directory where your package files are located
+    # Automatically find packages in the specified directory
+    packages=find_packages(where="src"),
+    project_urls={  # Optional
+        "Leonid Shpaner Website": "https://www.leonshpaner.com",
+        "Oscar Gil Website": "https://www.oscargildata.com",
+        "Source Code": "https://github.com/lshpaner/eda_kit/",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],  # Classifiers for the package
+    python_requires=">=3.6",  # Minimum version of Python required
+    install_requires=[
+        "jinja2>=3.1.4",  # Minimum version of jinja2 required
+        "numpy>=1.21.6",  # Minimum version of numpy required
+        "pandas>=1.3.5",  # Minimum version of pandas required
+        "matplotlib>=3.5.3",  # Minimum version of matplotlib required
+        "seaborn>=0.12.2",  # Minimum version of seaborn required
+        "xlsxwriter>=3.2.0",  # Minimum version of xlsxwriter required
+    ],
+)

eda_toolkit-0.0.1a0/src/eda_toolkit.egg-info/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.1
+Name: eda_toolkit
+Version: 0.0.1a0
+Summary: A Python library for EDA (directory management, some data preprocessing, reporting, visualizations, and more)
+Author: Leonid Shpaner, Oscar Gil
+Author-email: lshpaner@ucla.edu
+Project-URL: Leonid Shpaner Website, https://www.leonshpaner.com
+Project-URL: Oscar Gil Website, https://www.oscargildata.com
+Project-URL: Source Code, https://github.com/lshpaner/eda_kit/
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: jinja2>=3.1.4
+Requires-Dist: numpy>=1.21.6
+Requires-Dist: pandas>=1.3.5
+Requires-Dist: matplotlib>=3.5.3
+Requires-Dist: seaborn>=0.12.2
+Requires-Dist: xlsxwriter>=3.2.0
+
+# EDA Kit
+Welcome to EDA Kit, a collection of utility functions designed to streamline your exploratory data analysis (EDA) tasks. This repository offers tools for directory management, data preprocessing, reporting, visualization, and more, helping you efficiently handle various aspects of data manipulation and analysis.
+
+
+## Prerequisites
+
+Before you install `eda_kit`, ensure your system meets the following requirements:
+
+- `Python`: Version `3.7.4` or higher is required to run `eda_kit`.
+
+
+Additionally, `eda_kit` depends on the following packages, which will be automatically installed when you install `eda_kit`:
+
+- `numpy`: Version 1.21.6 or higher
+- `pandas`: Version 1.3.5 or higher
+- `matplotlib`: version 3.5.3 or higher
+- `seaborn`: version 0.12.2 or higher
+- `jinja2`: Version 3.1.4 or higher
+- `xlsxwriter`: version 3.2.0 or higher
+
+
+## Installation
+
+You can install `eda_kit` directly from PyPI:
+
+```bash
+pip install eda_kit
+```
+
+## 🌐 Authors' Websites
+
+https://www.leonshpaner.com  
+https://www.oscargildata.com 
+
+
+## ⚖️ License
+
+`eda_kit` is distributed under the MIT License. See [LICENSE](https://github.com/lshpaner/eda_kit/blob/readme/LICENSE.md) for more information.
+
+
+## Support
+
+If you have any questions or issues with `eda_kit`, please open an issue on this GitHub repository.
+
+
+
+

eda_toolkit-0.0.1a0/src/eda_toolkit.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+LICENSE.md
+README.md
+setup.py
+src/eda_toolkit.egg-info/PKG-INFO
+src/eda_toolkit.egg-info/SOURCES.txt
+src/eda_toolkit.egg-info/dependency_links.txt
+src/eda_toolkit.egg-info/requires.txt
+src/eda_toolkit.egg-info/top_level.txt

eda_toolkit-0.0.1a0/src/eda_toolkit.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

eda_toolkit-0.0.1a0/src/eda_toolkit.egg-info/requires.txt

@@ -0,0 +1,6 @@
+jinja2>=3.1.4
+numpy>=1.21.6
+pandas>=1.3.5
+matplotlib>=3.5.3
+seaborn>=0.12.2
+xlsxwriter>=3.2.0

eda_toolkit-0.0.1a0/src/eda_toolkit.egg-info/top_level.txt

@@ -0,0 +1 @@
+