Skip to main content

Collection of scripts for data analytics of Ask Data Through LibraryH3lp API - metadata only

Project description

sp_school_data_crunching# SP Ask School Data Crunching

A Python package for analyzing LibraryH3lp chat data for Scholars Portal Ask service. This package provides tools for visualizing and analyzing chat patterns, operator workload, and institutional interactions across Ontario universities.

Features

  • Comprehensive chat analysis across multiple dimensions:

    • Time-based analysis (hourly, daily, monthly patterns)
    • Operator workload analysis
    • School-specific metrics
    • Cross-institutional chat flows
    • Local vs non-local operator distribution
  • Interactive visualizations:

    • Time analysis charts
    • Operator performance metrics
    • Seasonal patterns
    • Chat flow chord diagrams
    • Heatmaps and distribution plots
  • Statistical analysis including:

    • Basic chat metrics
    • Response time analysis
    • Wait time patterns
    • Chat duration statistics
    • Correlation analysis

Installation

pip install sp-ask-school-data-crunching

Dependencies

  • sp-ask-school (>= 0.3.9)
  • lh3api (>= 0.2.0)
  • pandas
  • plotly
  • scipy
  • numpy

Usage

Basic Analysis

from sp_ask_school_data_crunching import analyze_school

# Analyze a specific school's data
analyzer = analyze_school(
    school_name="University of Toronto",
    start_date="2024-01-01",
    end_date="2024-12-31"
)

Advanced Usage

from sp_ask_school_data_crunching import SchoolChatAnalytics

# Initialize analyzer
analyzer = SchoolChatAnalytics(
    school_name="University of Toronto",
    start_date="2024-01-01",
    end_date="2024-01-31"
)

# Generate specific visualizations
analyzer.create_time_analysis()           # Creates time-based analysis
analyzer.save_individual_visualizations() # Creates individual charts
analyzer.generate_chord_diagram()         # Creates chat flow diagram
analyzer.analyze_operator_location()      # Analyzes local vs non-local operators

# Get statistics
stats = analyzer.advanced_statistics()

Generated Reports and Visualizations

The package generates several HTML files containing interactive visualizations:

  1. [School_Name]_time_analysis.html

    • Hourly chat distribution
    • Day of week distribution
    • Chat duration patterns
    • Wait time patterns
  2. [School_Name]_operator_analysis.html

    • Operator workload
    • Performance metrics
    • Response time analysis
  3. [School_Name]_seasonal_analysis.html

    • Monthly patterns
    • Yearly trends
    • Seasonal variations
  4. [School_Name]_chord_diagram.html

    • Inter-institutional chat flows
    • Operator distribution patterns
  5. [School_Name]_dashboard.html

    • Combined visualization dashboard
    • Comprehensive metrics view

License

MIT License

Authors

Guinsly Mondésir

Maintained by

Scholars Portal

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Citing

If you use this package in your research, please cite:

@software{sp_ask_school_data_crunching,
  author = {Mondésir, Guinsly},
  title = {SP Ask School Data Crunching},
  year = {2024},
  publisher = {Scholars Portal},
  version = {0.1.0}
}

Support

For support or questions, please:

  1. Open an issue on GitHub
  2. Contact Scholars Portal support
  3. Check the documentation

Changelog

0.1.0 (2024-01-01)

  • Initial release
  • Basic analysis features
  • Core visualizations
  • Statistical analysis tools

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sp_ask_school_data_crunching-0.1.2.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sp_ask_school_data_crunching-0.1.2-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file sp_ask_school_data_crunching-0.1.2.tar.gz.

File metadata

File hashes

Hashes for sp_ask_school_data_crunching-0.1.2.tar.gz
Algorithm Hash digest
SHA256 4e8c3287109b34b709d0514153e45f42ffee5ee0d498563e747c6f00eabc5a39
MD5 2fe539bfc70b3c292d5a5480f0ae11a8
BLAKE2b-256 8feb2a7c63249c27b9d50b5d717f3ffef584854d5488b059ec87156ae2387c47

See more details on using hashes here.

File details

Details for the file sp_ask_school_data_crunching-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for sp_ask_school_data_crunching-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d5fe6dbb32a7cd29aa8d8a531e4e2c33cf69424e4f9ad3556c594e8abce2260
MD5 de5bbb3cc7ce5a849f4b58be294b9f89
BLAKE2b-256 e3db28f7afea054173a7a5eae0eeee124198154e0fc3e40e47b3493939e049d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page