imsciences 0.5.4.7__py3-none-any.whl → 0.9.3__py3-none-any.whl

imsciences/vis.py

@@ -0,0 +1,196 @@
+import pandas as pd
+import plotly.express as px
+import plotly.graph_objs as go
+
+class datavis: 
+    
+    def help(self):
+        """
+        Displays a help menu listing all the available functions with their descriptions, usage, and examples.
+        """        
+        print("1. plot_one")
+        print("   - Description: Plots a specified column from a DataFrame with white background and black axes.")
+        print("   - Usage: plot_one(df1, col1, date_column)")
+        print("   - Example: plot_one(df, 'sales', 'date')\n")
+        
+        print("2. plot_two")
+        print("   - Description: Plots specified columns from two DataFrames, optionally on the same or separate y-axes.")
+        print("   - Usage: plot_two(df1, col1, df2, col2, date_column, same_axis=True)")
+        print("   - Example: plot_two(df1, 'sales_vol', df2, 'sales_revenue', 'date', same_axis=False)\n")
+        
+        print("3. plot_chart")
+        print("   - Description: Plots various chart types using Plotly, including line, bar, scatter, area, pie, etc.")
+        print("   - Usage: plot_chart(df, date_col, value_cols, chart_type='line', title='Chart', x_title='Date', y_title='Values')")
+        print("   - Example: plot_chart(df, 'date', ['sales', 'revenue'], chart_type='line', title='Sales and Revenue')\n")
+    
+    def plot_one(self, df1, col1, date_column):
+        """
+        Plots specified column from a DataFrame with white background and black axes,
+        using a specified date column as the X-axis.
+
+        :param df1: DataFrame
+        :param col1: Column name from the DataFrame
+        :param date_column: The name of the date column to use for the X-axis
+        """
+        # Check if columns exist in the DataFrame
+        if col1 not in df1.columns or date_column not in df1.columns:
+            raise ValueError("Column not found in DataFrame")
+
+        # Check if the date column is in datetime format, if not convert it
+        if not pd.api.types.is_datetime64_any_dtype(df1[date_column]):
+            try:
+                # Convert with dayfirst=True to interpret dates correctly
+                df1[date_column] = pd.to_datetime(df1[date_column], dayfirst=True)
+            except Exception as e:
+                raise ValueError(f"Error converting {date_column} to datetime: {e}")
+
+        # Plotting using Plotly Express
+        fig = px.line(df1, x=date_column, y=col1)
+
+        # Update layout for white background and black axes lines, and setting y-axis to start at 0
+        fig.update_layout(
+            plot_bgcolor='white',
+            xaxis=dict(
+                showline=True,
+                linecolor='black'
+            ),
+            yaxis=dict(
+                showline=True,
+                linecolor='black',
+                rangemode='tozero'  # Setting Y-axis to start at 0 if suitable
+            )
+        )
+
+        return fig
+
+    def plot_two(self, df1, col1, df2, col2, date_column, same_axis=True):
+        """
+        Plots specified columns from two different DataFrames with both different and the same lengths,
+        using a specified date column as the X-axis, and charting on either the same or separate y-axes.
+
+        :param df1: First DataFrame
+        :param col1: Column name from the first DataFrame
+        :param df2: Second DataFrame
+        :param col2: Column name from the second DataFrame
+        :param date_column: The name of the date column to use for the X-axis
+        :param same_axis: If True, plot both traces on the same y-axis; otherwise, use separate y-axes.
+        :return: Plotly figure
+        """
+        # Validate inputs
+        if col1 not in df1.columns or date_column not in df1.columns:
+            raise ValueError(f"Column {col1} or {date_column} not found in the first DataFrame.")
+        if col2 not in df2.columns or date_column not in df2.columns:
+            raise ValueError(f"Column {col2} or {date_column} not found in the second DataFrame.")
+
+        # Ensure date columns are in datetime format
+        df1[date_column] = pd.to_datetime(df1[date_column], errors='coerce')
+        df2[date_column] = pd.to_datetime(df2[date_column], errors='coerce')
+
+        # Drop rows with invalid dates
+        df1 = df1.dropna(subset=[date_column])
+        df2 = df2.dropna(subset=[date_column])
+
+        # Create traces for the first and second DataFrames
+        trace1 = go.Scatter(x=df1[date_column], y=df1[col1], mode='lines', name=col1, yaxis='y1')
+
+        if same_axis:
+            trace2 = go.Scatter(x=df2[date_column], y=df2[col2], mode='lines', name=col2, yaxis='y1')
+        else:
+            trace2 = go.Scatter(x=df2[date_column], y=df2[col2], mode='lines', name=col2, yaxis='y2')
+
+        # Define layout for the plot
+        layout = go.Layout(
+            title="Comparison Plot",
+            xaxis=dict(title=date_column, showline=True, linecolor='black'),
+            yaxis=dict(
+                title=col1 if same_axis else f"{col1} (y1)",
+                showline=True,
+                linecolor='black',
+                rangemode='tozero'
+            ),
+            yaxis2=dict(
+                title=f"{col2} (y2)" if not same_axis else "",
+                overlaying='y',
+                side='right',
+                showline=True,
+                linecolor='black',
+                rangemode='tozero'
+            ),
+            showlegend=True,
+            plot_bgcolor='white'  # Set the plot background color to white
+        )
+
+        # Create the figure with the defined layout and traces
+        fig = go.Figure(data=[trace1, trace2], layout=layout)
+
+        return fig
+
+    def plot_chart(self, df, date_col, value_cols, chart_type='line', title='Chart', x_title='Date', y_title='Values', **kwargs):
+        """
+        Plot various types of charts using Plotly.
+
+        Args:
+            df (pandas.DataFrame): DataFrame containing the data.
+            date_col (str): The name of the column with date information.
+            value_cols (list): List of columns to plot.
+            chart_type (str): Type of chart to plot ('line', 'bar', 'scatter', etc.).
+            title (str): Title of the chart.
+            x_title (str): Title of the x-axis.
+            y_title (str): Title of the y-axis.
+            **kwargs: Additional keyword arguments for customization.
+
+        Returns:
+            plotly.graph_objects.Figure: The Plotly figure object.
+        """
+        import pandas as pd
+        import plotly.graph_objects as go
+
+        # Ensure the date column is in datetime format
+        df[date_col] = pd.to_datetime(df[date_col])
+
+        # Validate input columns
+        value_cols = [col for col in value_cols if col in df.columns and col != date_col]
+        if not value_cols:
+            raise ValueError("No valid columns provided for plotting.")
+
+        # Initialize the figure
+        fig = go.Figure()
+
+        # Define a mapping for chart types to corresponding Plotly trace types
+        chart_trace_map = {
+            'line': lambda col: go.Scatter(x=df[date_col], y=df[col], mode='lines', name=col, **kwargs),
+            'bar': lambda col: go.Bar(x=df[date_col], y=df[col], name=col, **kwargs),
+            'scatter': lambda col: go.Scatter(x=df[date_col], y=df[col], mode='markers', name=col, **kwargs),
+            'area': lambda col: go.Scatter(x=df[date_col], y=df[col], mode='lines', fill='tozeroy', name=col, **kwargs),
+            'pie': lambda col: go.Pie(labels=df[date_col], values=df[col], name=col, **kwargs),
+            'box': lambda col: go.Box(y=df[col], name=col, **kwargs),
+            'bubble': lambda _: go.Scatter(
+                x=df[value_cols[0]], y=df[value_cols[1]], mode='markers',
+                marker=dict(size=df[value_cols[2]]), name='Bubble Chart', **kwargs
+            ),
+            'funnel': lambda col: go.Funnel(y=df[date_col], x=df[col], **kwargs),
+            'waterfall': lambda col: go.Waterfall(x=df[date_col], y=df[col], measure=df[value_cols[1]], **kwargs),
+            'scatter3d': lambda _: go.Scatter3d(
+                x=df[value_cols[0]], y=df[value_cols[1]], z=df[value_cols[2]],
+                mode='markers', **kwargs
+            )
+        }
+
+        # Generate traces for the selected chart type
+        if chart_type in chart_trace_map:
+            for col in value_cols:
+                trace = chart_trace_map[chart_type](col)
+                fig.add_trace(trace)
+        else:
+            raise ValueError(f"Unsupported chart type: {chart_type}")
+
+        # Update the layout of the figure
+        fig.update_layout(
+            title=title,
+            xaxis_title=x_title,
+            yaxis_title=y_title,
+            legend_title='Series',
+            template='plotly_dark'
+        )
+
+        return fig

imsciences-0.9.3.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Independent Marketing Sciences
+
+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.

imsciences-0.9.3.dist-info/METADATA

@@ -0,0 +1,330 @@
+Metadata-Version: 2.1
+Name: imsciences
+Version: 0.9.3
+Summary: IMS Data Processing Package
+Author: IMS
+Author-email: cam@im-sciences.com
+Keywords: python,data processing,apis
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: pandas
+Requires-Dist: plotly
+Requires-Dist: numpy
+Requires-Dist: fredapi
+Requires-Dist: bs4
+Requires-Dist: yfinance
+Requires-Dist: holidays
+Requires-Dist: google-analytics-data
+Requires-Dist: geopandas
+
+# IMS Package Documentation
+
+The **Independent Marketing Sciences** package is a Python library designed to process incoming data into a format tailored for projects, particularly those utilising weekly time series data. This package offers a suite of functions for efficient data collection, manipulation, visualisation and analysis.
+
+---
+
+## Key Features
+- Seamless data processing for time series workflows.
+- Aggregation, filtering, and transformation of time series data.
+- Visualising Data
+- Integration with external data sources like FRED, Bank of England, ONS and OECD.
+
+---
+
+Table of Contents
+=================
+
+1. [Data Processing for Time Series](#data-processing-for-time-series)
+2. [Data Processing for Incrementality Testing](#data-processing-for-incrementality-testing)
+3. [Data Visualisations](#data-visualisations)
+4. [Data Pulling](#data-pulling)
+5. [Installation](#installation)
+6. [Usage](#usage)
+7. [License](#license)
+
+---
+
+## Data Processing for Time Series
+
+## 1. `get_wd_levels`
+- **Description**: Get the working directory with the option of moving up parents.
+- **Usage**: `get_wd_levels(levels)`
+- **Example**: `get_wd_levels(0)`
+
+## 2. `aggregate_daily_to_wc_long`
+- **Description**: Aggregates daily data into weekly data, grouping and summing specified columns, starting on a specified day of the week.
+- **Usage**: `aggregate_daily_to_wc_long(df, date_column, group_columns, sum_columns, wc, aggregation='sum')`
+- **Example**: `aggregate_daily_to_wc_long(df, 'date', ['platform'], ['cost', 'impressions', 'clicks'], 'mon', 'average')`
+
+## 3. `convert_monthly_to_daily`
+- **Description**: Converts monthly data in a DataFrame to daily data by expanding and dividing the numeric values.
+- **Usage**: `convert_monthly_to_daily(df, date_column, divide=True)`
+- **Example**: `convert_monthly_to_daily(df, 'date')`
+
+## 4. `week_of_year_mapping`
+- **Description**: Converts a week column in 'yyyy-Www' or 'yyyy-ww' format to week commencing date.
+- **Usage**: `week_of_year_mapping(df, week_col, start_day_str)`
+- **Example**: `week_of_year_mapping(df, 'week', 'mon')`
+
+## 5. `rename_cols`
+- **Description**: Renames columns in a pandas DataFrame with a specified prefix or format.
+- **Usage**: `rename_cols(df, name='ame_')`
+- **Example**: `rename_cols(df, 'ame_facebook')`
+
+## 6. `merge_new_and_old`
+- **Description**: Creates a new DataFrame by merging old and new dataframes based on a cutoff date.
+- **Usage**: `merge_new_and_old(old_df, old_col, new_df, new_col, cutoff_date, date_col_name='OBS')`
+- **Example**: `merge_new_and_old(df1, 'old_col', df2, 'new_col', '2023-01-15')`
+
+## 7. `merge_dataframes_on_column`
+- **Description**: Merge a list of DataFrames on a common column.
+- **Usage**: `merge_dataframes_on_column(dataframes, common_column='OBS', merge_how='outer')`
+- **Example**: `merge_dataframes_on_column([df1, df2, df3], common_column='OBS', merge_how='outer')`
+
+## 8. `merge_and_update_dfs`
+- **Description**: Merges two dataframes, updating columns from the second dataframe where values are available.
+- **Usage**: `merge_and_update_dfs(df1, df2, key_column)`
+- **Example**: `merge_and_update_dfs(processed_facebook, finalised_meta, 'OBS')`
+
+## 9. `convert_us_to_uk_dates`
+- **Description**: Convert a DataFrame column with mixed US and UK date formats to datetime.
+- **Usage**: `convert_us_to_uk_dates(df, date_col)`
+- **Example**: `convert_us_to_uk_dates(df, 'date')`
+
+## 10. `combine_sheets`
+- **Description**: Combines multiple DataFrames from a dictionary into a single DataFrame.
+- **Usage**: `combine_sheets(all_sheets)`
+- **Example**: `combine_sheets({'Sheet1': df1, 'Sheet2': df2})`
+
+## 11. `pivot_table`
+- **Description**: Dynamically pivots a DataFrame based on specified columns.
+- **Usage**: `pivot_table(df, index_col, columns, values_col, filters_dict=None, fill_value=0, aggfunc='sum', margins=False, margins_name='Total', datetime_trans_needed=True, reverse_header_order=False, fill_missing_weekly_dates=False, week_commencing='W-MON')`
+- **Example**: `pivot_table(df, 'OBS', 'Channel Short Names', 'Value', filters_dict={'Master Include': ' == 1'}, fill_value=0)`
+
+## 12. `apply_lookup_table_for_columns`
+- **Description**: Maps substrings in columns to new values based on a dictionary.
+- **Usage**: `apply_lookup_table_for_columns(df, col_names, to_find_dict, if_not_in_dict='Other', new_column_name='Mapping')`
+- **Example**: `apply_lookup_table_for_columns(df, col_names, {'spend': 'spd'}, if_not_in_dict='Other', new_column_name='Metrics Short')`
+
+## 13. `aggregate_daily_to_wc_wide`
+- **Description**: Aggregates daily data into weekly data and pivots it to wide format.
+- **Usage**: `aggregate_daily_to_wc_wide(df, date_column, group_columns, sum_columns, wc='sun', aggregation='sum', include_totals=False)`
+- **Example**: `aggregate_daily_to_wc_wide(df, 'date', ['platform'], ['cost', 'impressions'], 'mon', 'average', True)`
+
+## 14. `merge_cols_with_seperator`
+- **Description**: Merges multiple columns in a DataFrame into one column with a specified separator.
+- **Usage**: `merge_cols_with_seperator(df, col_names, separator='_', output_column_name='Merged')`
+- **Example**: `merge_cols_with_seperator(df, ['Campaign', 'Product'], separator='|', output_column_name='Merged Columns')`
+
+## 15. `check_sum_of_df_cols_are_equal`
+- **Description**: Checks if the sum of two columns in two DataFrames are equal and provides the difference.
+- **Usage**: `check_sum_of_df_cols_are_equal(df_1, df_2, cols_1, cols_2)`
+- **Example**: `check_sum_of_df_cols_are_equal(df_1, df_2, 'Media Cost', 'Spend')`
+
+## 16. `convert_2_df_cols_to_dict`
+- **Description**: Creates a dictionary from two DataFrame columns.
+- **Usage**: `convert_2_df_cols_to_dict(df, key_col, value_col)`
+- **Example**: `convert_2_df_cols_to_dict(df, 'Campaign', 'Channel')`
+
+## 17. `create_FY_and_H_columns`
+- **Description**: Adds financial year and half-year columns to a DataFrame based on a start date.
+- **Usage**: `create_FY_and_H_columns(df, index_col, start_date, starting_FY, short_format='No', half_years='No', combined_FY_and_H='No')`
+- **Example**: `create_FY_and_H_columns(df, 'Week', '2022-10-03', 'FY2023', short_format='Yes')`
+
+## 18. `keyword_lookup_replacement`
+- **Description**: Updates values in a column based on a lookup dictionary with conditional logic.
+- **Usage**: `keyword_lookup_replacement(df, col, replacement_rows, cols_to_merge, replacement_lookup_dict, output_column_name='Updated Column')`
+- **Example**: `keyword_lookup_replacement(df, 'channel', 'Paid Search Generic', ['channel', 'segment'], lookup_dict, output_column_name='Channel New')`
+
+## 19. `create_new_version_of_col_using_LUT`
+- **Description**: Creates a new column based on a lookup table applied to an existing column.
+- **Usage**: `create_new_version_of_col_using_LUT(df, keys_col, value_col, dict_for_specific_changes, new_col_name='New Version of Old Col')`
+- **Example**: `create_new_version_of_col_using_LUT(df, 'Campaign Name', 'Campaign Type', lookup_dict)`
+
+## 20. `convert_df_wide_2_long`
+- **Description**: Converts a wide-format DataFrame into a long-format DataFrame.
+- **Usage**: `convert_df_wide_2_long(df, value_cols, variable_col_name='Stacked', value_col_name='Value')`
+- **Example**: `convert_df_wide_2_long(df, ['col1', 'col2'], variable_col_name='Var', value_col_name='Val')`
+
+## 21. `manually_edit_data`
+- **Description**: Manually updates specified cells in a DataFrame based on filters.
+- **Usage**: `manually_edit_data(df, filters_dict, col_to_change, new_value, change_in_existing_df_col='No', new_col_to_change_name='New', manual_edit_col_name=None, add_notes='No', existing_note_col_name=None, note=None)`
+- **Example**: `manually_edit_data(df, {'col1': '== 1'}, 'col2', 'new_val', add_notes='Yes', note='Manual Update')`
+
+## 22. `format_numbers_with_commas`
+- **Description**: Formats numerical columns with commas and a specified number of decimal places.
+- **Usage**: `format_numbers_with_commas(df, decimal_length_chosen=2)`
+- **Example**: `format_numbers_with_commas(df, decimal_length_chosen=1)`
+
+## 23. `filter_df_on_multiple_conditions`
+- **Description**: Filters a DataFrame based on multiple column conditions.
+- **Usage**: `filter_df_on_multiple_conditions(df, filters_dict)`
+- **Example**: `filter_df_on_multiple_conditions(df, {'col1': '>= 5', 'col2': '== 'val''})`
+
+## 24. `read_and_concatenate_files`
+- **Description**: Reads and concatenates files from a specified folder into a single DataFrame.
+- **Usage**: `read_and_concatenate_files(folder_path, file_type='csv')`
+- **Example**: `read_and_concatenate_files('/path/to/files', file_type='xlsx')`
+
+## 25. `upgrade_outdated_packages`
+- **Description**: Upgrades all outdated Python packages except specified ones.
+- **Usage**: `upgrade_outdated_packages(exclude_packages=['twine'])`
+- **Example**: `upgrade_outdated_packages(exclude_packages=['pip', 'setuptools'])`
+
+## 26. `convert_mixed_formats_dates`
+- **Description**: Converts mixed-format date columns into standardized datetime format.
+- **Usage**: `convert_mixed_formats_dates(df, column_name)`
+- **Example**: `convert_mixed_formats_dates(df, 'date_col')`
+
+## 27. `fill_weekly_date_range`
+- **Description**: Fills in missing weekly dates in a DataFrame with a specified frequency.
+- **Usage**: `fill_weekly_date_range(df, date_column, freq='W-MON')`
+- **Example**: `fill_weekly_date_range(df, 'date_col')`
+
+## 28. `add_prefix_and_suffix`
+- **Description**: Adds prefixes and/or suffixes to column names, with an option to exclude a date column.
+- **Usage**: `add_prefix_and_suffix(df, prefix='', suffix='', date_col=None)`
+- **Example**: `add_prefix_and_suffix(df, prefix='pre_', suffix='_suf', date_col='date_col')`
+
+## 29. `create_dummies`
+- **Description**: Creates dummy variables for columns, with an option to add a total dummy column.
+- **Usage**: `create_dummies(df, date_col=None, dummy_threshold=0, add_total_dummy_col='No', total_col_name='total')`
+- **Example**: `create_dummies(df, date_col='date_col', dummy_threshold=1)`
+
+## 30. `replace_substrings`
+- **Description**: Replaces substrings in a column based on a dictionary, with options for case conversion and new column creation.
+- **Usage**: `replace_substrings(df, column, replacements, to_lower=False, new_column=None)`
+- **Example**: `replace_substrings(df, 'text_col', {'old': 'new'}, to_lower=True, new_column='updated_text')`
+
+## 31. `add_total_column`
+- **Description**: Adds a total column to a DataFrame by summing values across columns, optionally excluding one.
+- **Usage**: `add_total_column(df, exclude_col=None, total_col_name='Total')`
+- **Example**: `add_total_column(df, exclude_col='date_col')`
+
+## 32. `apply_lookup_table_based_on_substring`
+- **Description**: Categorizes text in a column using a lookup table based on substrings.
+- **Usage**: `apply_lookup_table_based_on_substring(df, column_name, category_dict, new_col_name='Category', other_label='Other')`
+- **Example**: `apply_lookup_table_based_on_substring(df, 'text_col', {'sub1': 'cat1', 'sub2': 'cat2'})`
+
+## 33. `compare_overlap`
+- **Description**: Compares overlapping periods between two DataFrames and summarizes differences.
+- **Usage**: `compare_overlap(df1, df2, date_col)`
+- **Example**: `compare_overlap(df1, df2, 'date_col')`
+
+## 34. `week_commencing_2_week_commencing_conversion_isoweekday`
+- **Description**: Maps dates to the start of the current ISO week based on a specified weekday.
+- **Usage**: `week_commencing_2_week_commencing_conversion_isoweekday(df, date_col, week_commencing='mon')`
+- **Example**: `week_commencing_2_week_commencing_conversion_isoweekday(df, 'date_col', week_commencing='fri')`
+
+---
+
+## Data Processing for Incrementality Testing
+
+## 1. `pull_ga`
+- **Description**: Pull in GA4 data for geo experiments.
+- **Usage**: `pull_ga(credentials_file, property_id, start_date, country, metrics)`
+- **Example**: `pull_ga('GeoExperiment-31c5f5db2c39.json', '111111111', '2023-10-15', 'United Kingdom', ['totalUsers', 'newUsers'])`
+
+## 2. `process_itv_analysis`
+- **Description**: Pull in GA4 data for geo experiments.
+- **Usage**: `process_itv_analysis(self, raw_df, itv_path, cities_path, media_spend_path, output_path, group1, group2)`
+- **Example**: `process_itv_analysis(df, 'itv regional mapping.csv', 'Geo_Mappings_with_Coordinates.xlsx', 'IMS.xlsx', 'itv_for_test_analysis_itvx.csv', ['West', 'Westcountry', 'Tyne Tees'], ['Central Scotland', 'North Scotland'])`
+
+---
+
+## Data Visualisations
+
+## 1. `plot_one`
+- **Description**: Plots a specified column from a DataFrame with white background and black axes.
+- **Usage**: `plot_one(df1, col1, date_column)`
+- **Example**: `plot_one(df, 'sales', 'date')`
+
+## 2. `plot_two`
+- **Description**: Plots specified columns from two DataFrames, optionally on the same or separate y-axes.
+- **Usage**: `plot_two(df1, col1, df2, col2, date_column, same_axis=True)`
+- **Example**: `plot_two(df1, 'sales', df2, 'revenue', 'date', same_axis=False)`
+
+## 3. `plot_chart`
+- **Description**: Plots various chart types using Plotly, including line, bar, scatter, area, pie, etc.
+- **Usage**: `plot_chart(df, date_col, value_cols, chart_type='line', title='Chart', x_title='Date', y_title='Values')`
+- **Example**: `plot_chart(df, 'date', ['sales', 'revenue'], chart_type='line', title='Sales and Revenue')`
+
+---
+
+## Data Pulling
+
+## 1. `pull_fred_data`
+- **Description**: Fetch data from FRED using series ID tokens.
+- **Usage**: `pull_fred_data(week_commencing, series_id_list)`
+- **Example**: `pull_fred_data('mon', ['GPDIC1', 'Y057RX1Q020SBEA', 'GCEC1', 'ND000333Q', 'Y006RX1Q020SBEA'])`
+
+## 2. `pull_boe_data`
+- **Description**: Fetch and process Bank of England interest rate data.
+- **Usage**: `pull_boe_data(week_commencing)`
+- **Example**: `pull_boe_data('mon')`
+
+## 3. `pull_oecd`
+- **Description**: Fetch macroeconomic data from OECD for a specified country.
+- **Usage**: `pull_oecd(country='GBR', week_commencing='mon', start_date='2020-01-01')`
+- **Example**: `pull_oecd('GBR', 'mon', '2000-01-01')`
+
+## 4. `get_google_mobility_data`
+- **Description**: Fetch Google Mobility data for the specified country.
+- **Usage**: `get_google_mobility_data(country, wc)`
+- **Example**: `get_google_mobility_data('United Kingdom', 'mon')`
+
+## 5. `pull_seasonality`
+- **Description**: Generate combined dummy variables for seasonality, trends, and COVID lockdowns.
+- **Usage**: `pull_seasonality(week_commencing, start_date, countries)`
+- **Example**: `pull_seasonality('mon', '2020-01-01', ['US', 'GB'])`
+
+## 6. `pull_weather`
+- **Description**: Fetch and process historical weather data for the specified country.
+- **Usage**: `pull_weather(week_commencing, country)`
+- **Example**: `pull_weather('mon', 'GBR')`
+
+## 7. `pull_macro_ons_uk`
+- **Description**: Fetch and process time series data from the Beta ONS API.
+- **Usage**: `pull_macro_ons_uk(additional_list, week_commencing, sector)`
+- **Example**: `pull_macro_ons_uk(['HBOI'], 'mon', 'fast_food')`
+
+## 8. `pull_yfinance`
+- **Description**: Fetch and process time series data from Yahoo Finance.
+- **Usage**: `pull_yfinance(tickers, week_start_day)`
+- **Example**: `pull_yfinance(['^FTMC', '^IXIC'], 'mon')`
+
+---
+
+## Installation
+
+Install the IMS package via pip:
+
+```bash
+pip install imsciences
+```
+
+---
+
+## Usage 
+
+```bash
+from imsciences import * 
+ims_proc = dataprocessing()
+ims_geo = geoprocessing()
+ims_pull = datapull()
+ims_vis = datavis()
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License. ![License](https://img.shields.io/badge/license-MIT-blue.svg)
+
+---

imsciences-0.9.3.dist-info/PKG-INFO-IMS-24Ltp-3

@@ -0,0 +1,24 @@
+Metadata-Version: 2.1
+Name: imsciences
+Version: 0.6.1.1
+Summary: IMS Data Processing Package
+Author: IMS
+Author-email: cam@im-sciences.com
+Keywords: python,data processing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Description-Content-Type: text/markdown
+Requires-Dist: pandas
+
+# IMS Package Documentation
+
+The IMS package is a python library for processing incoming data into a format that can be used for projects. IMS processing offers a variety of functions to manipulate and analyze data efficiently. Here are the functionalities provided by the package:
+
+## Data Processing
+
+## Data Pulling
+

imsciences-0.9.3.dist-info/RECORD

@@ -0,0 +1,22 @@
+dataprocessing/__init__.py,sha256=quSwsLs6IuLoA5Rzi0ZD40xZaQudwDteF7_ai9JfTPk,32
+dataprocessing/data-processing-functions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
+dataprocessing/datafunctions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
+imsciences/__init__.py,sha256=_HuYeLbDMTdt7GpKI4r6-d7yRPZgcAQ7yOW0-ydR2Yo,117
+imsciences/datafunctions-IMS-24Ltp-3.py,sha256=3Snv-0iE_03StmyjtT-riOU9f4v8TaJWLoyZLJp6l8Y,141406
+imsciences/datafunctions.py,sha256=WZrXNLO-SYrCuFt0pAbha74psMOZPY7meWJ7yWEbRpk,169953
+imsciences/datapull.py,sha256=TPY0LDgOkcKTBk8OekbD0Grg5x0SomAK2dZ7MuT6X1E,19000
+imsciences/geo.py,sha256=bhtA8s4enWgT8oxyVP6inUgo_rvAEyZY-K6XnOizhkE,9530
+imsciences/mmm.py,sha256=ZV_mzUYbpLfcSYyGKNGyHRs5pKpGPtzB-zJxyq08ul4,73914
+imsciences/pull.py,sha256=bGz8B7bBQ5b9hrx3ipCFTWl_eebEb7rPL4dANKiVWTY,74015
+imsciences/unittesting.py,sha256=DYGqVCsZHrs_tZ-EXDW8q8CdlcsTnG8HsnmWjEE521c,45691
+imsciences/vis.py,sha256=2izdHQhmWEReerRqIxhY4Ai10VjL7xoUqyWyZC7-2XI,8931
+imsciencesdataprocessing/__init__.py,sha256=quSwsLs6IuLoA5Rzi0ZD40xZaQudwDteF7_ai9JfTPk,32
+imsciencesdataprocessing/datafunctions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
+imsdataprocessing/__init__.py,sha256=quSwsLs6IuLoA5Rzi0ZD40xZaQudwDteF7_ai9JfTPk,32
+imsdataprocessing/datafunctions.py,sha256=vE1vsZ8xOSbR9Bwlp9SWXwEHXQ0nFydwGkvzHXf2f1Y,41
+imsciences-0.9.3.dist-info/LICENSE.txt,sha256=lVq2QwcExPX4Kl2DHeEkRrikuItcDB1Pr7yF7FQ8_z8,1108
+imsciences-0.9.3.dist-info/METADATA,sha256=IVP2fsJXuR_ePn0VFozQ7b_-BwOf9tdPBElGnphNv4Y,16612
+imsciences-0.9.3.dist-info/PKG-INFO-IMS-24Ltp-3,sha256=yqZbigwHjnYoqyI81PGz_AeofRFfOrwH_Vyawyef-mg,854
+imsciences-0.9.3.dist-info/WHEEL,sha256=ixB2d4u7mugx_bCBycvM9OzZ5yD7NmPXFRtKlORZS2Y,91
+imsciences-0.9.3.dist-info/top_level.txt,sha256=hsENS-AlDVRh8tQJ6-426iUQlla9bPcGc0-UlFF0_iU,11
+imsciences-0.9.3.dist-info/RECORD,,

{imsciences-0.5.4.7.dist-info → imsciences-0.9.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (74.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any