Metadata-Version: 2.1
Name: RhythmCount
Version: 1.1
Summary: Python package to analyse the rhythmicity in count data
Home-page: https://github.com/ninavelikajne/RhythmCount
Author: Nina Velikajne, Miha Moškon
Author-email: nv6920@student.uni-lj.si, miha.moskon@fri.uni-lj.si
License: UNKNOWN
Keywords: cosinor,rhytmometry,regression,count data
Platform: UNKNOWN
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.txt
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: statsmodels
Requires-Dist: scipy

# RhythmCount
RhythmCount represents a Python package for detecting and analysing rhythmic patterns in count data. It consists of two modules:

* data_processing: specific functions for building and comparing models, cleaning data, calculating confidence intervals, etc.

* plot: specific functions for plotting (e.g. plotting models, raw data).

To use these modules, add the following code to your Python file:

`from RhythmCount import plot, data_processing` 

RhythmCount can be used in combination with various types of experimental count data. The basic implementation of the RhythmCount for analysing rhythmic count data is made with cosinor method in combination 
with multiple regression models for count data: Poisson model, Generalized Poisson model, Zero-Inflated Poisson model, Negative Binomial model and Zero-Inflated Negative Binomial model. <br>

The input data must be in the required format. The data must contain X and Y columns, where X represents time and Y represents the target variable - count.
Once the data has been imported, various types of analysis can be performed. These are described more in details in the examples and documentation. <br/>
Helpers only contains functions that are called within the data_processing and plot modules. It is not intended for use by the end user.

# Installation
RhythmCount can be installed using pip with the command:

`pip install RhythmCount`

# Documentation and example
For more information see [RhythmCount](https://github.com/ninavelikajne/RhythmCount) on GitHub.

