Skip to content
 
 

Repository files navigation

Inflam

Continuous Integration build in GitHub Actions

Inflam is a data management system written in Python that manages trial data used in clinical inflammation studies.

Main features

Here are some key features of Inflam:

  • Provide basic statistical analyses over clinical trial data
  • Ability to work on trial data in Comma-Separated Value (CSV) format
  • Generate plots of trial data
  • Analytical functions and views can be easily extended based on its Model-View-Controller architecture

Prerequisites

Inflam requires the following Python packages:

  • NumPy - makes use of NumPy's statistical functions
  • Matplotlib - uses Matplotlib to generate statistical plots

The following optional packages are required to run Inflam's unit tests:

  • pytest - Inflam's unit tests are written using pytest
  • pytest-cov - Adds test coverage stats to unit testing

Installation

Clone the repository

Install requirements (preferably in a virtual environment)

python -m pip3 install requirements.txt

Usage

Open a terminal to the root of the repository on your local machine. Run the code with

python3 inflammation-analysis.py <path-to-your-data>

License

MIT License

Copyright (c) 2024 Marcus Quantrill

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.

About

The project starting point for the Intermediate Research Software Development Course

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages