Skip to content

Latest commit

 

History

History
190 lines (142 loc) · 6.83 KB

README.md

File metadata and controls

190 lines (142 loc) · 6.83 KB
Raw

Logo

🌩️ HMS - Exploratory Data Analysis and Journey in Neurocritical Care 🌍

A comprehensive exploration into neurocritical care using EEG data analysis.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Exploratory Data Analysis and Journey in Neurocritical Care is a project that delves deep into the analysis of EEG data to understand brain activity in critical care scenarios.

What is EEG?

Electroencephalography (EEG) is a non-invasive method used to record electrical activity in the brain. Learn more about EEG here.

How Spectrograms are Related to EEG?

Spectrograms play a crucial role in analyzing EEG data. Find out more about their relationship here.

LPD/GPD/LRDA/GRDA Conditions

Explore various brain conditions such as Lateralized Periodic Discharges (LPDs), Generalized Periodic Discharges (GPDs), Lateralized Rhythmic Delta Activity (LRDA), and Generalized Rhythmic Delta Activity (GRDA) here.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

Clone the repository 🚀

git clone https://github.com/ThecoderPinar/HMS-BrainActivity-Analysiss.git

🚀 Usage

Welcome to the usage section! Here, you'll find examples and code snippets to help you make the most of this project.

1. Data Analysis with Jupyter Notebooks

Navigate to the 📓 notebooks directory to find Jupyter notebooks for in-depth data analysis and visualization.

cd notebook/
jupyter notebook

2. Exploring EEG Data

Check out the 📂 data directory (please note, actual EEG data is not provided for privacy and ethical reasons). You can replace the placeholder with your own data.

📂 data

  • ├── train_eegs\1000913311.parquet
  • ├── train_spectrograms\1000189855.parquet
  • ├── sample_submission.csv
  • ├── test.csv
  • ├── train.csv

3. Project Documentation

Explore the 📚 docs directory for comprehensive project documentation, including this README.

cd docs/

4. Viewing Outputs

Navigate to the output directories:

📁 out

  • ├── submission.csv
  • ├── out_image/
  • └── out_audio/

📓 Notebook

Explore the analysis and visualization of harmful brain activity in the following Jupyter Notebook:

Feel free to open the notebook to dive into the details of our exploratory data analysis journey! 🧠📊

🚀 Roadmap

Here's what's coming up for this project:

🎉 Version 1.0.0 (Current Release)

  • 🚀 Initial release with basic functionalities.
  • 📊 Exploratory Data Analysis (EDA) on EEG data.
  • 📈 Implement basic data visualization techniques.

🌟 Version 1.1.0

  • 🎨 Add advanced visualization features.
  • 📉 Include statistical analysis of EEG patterns.
  • 📘 Improve documentation for better understanding.

✨ Version 1.2.0

  • 🤖 Integrate machine learning models for EEG pattern recognition.
  • 🎉 Enhance user interface for better user experience.
  • 🌐 Support for additional EEG datasets.

🚧 Version 1.3.0

  • ⏩ Implement real-time EEG data processing.
  • 📊 Provide interactive dashboards for data exploration.
  • 🤝 Collaborate with the community to address user feedback.

🔮 Future Releases

  • ☁️ Explore cloud-based EEG data analysis.
  • 📱 Develop mobile applications for on-the-go EEG analysis.
  • 🔄 Continuous improvement based on user feedback and technological advancements.

Feel free to suggest additional features or improvements by opening an issue or reaching out! 🚀

Contributing

Contributions make the open source community thrive. If you'd like to contribute to this project, follow these steps:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the Apache License 2.0. See LICENSE for more information.

Contact

If you want to reach out, feel free to contact me:

Pınar Topuz - [email protected]

Project Link: https://github.com/QMindSolutions/HMS-BrainActivity-Analysis

Acknowledgements

Give credit to the tools, libraries, or resources you used or were inspired by in this project. It's a great way to show appreciation.