Metadata-Version: 2.4
Name: stats-misc
Version: 0.3.5
Summary: Statistical functions not included by canonical Python analytical packages.
Author-email: Amand Floriaan Schmidt <floriaanschmidt@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://gitlab.com/SchmidtAF/stats-misc
Project-URL: Documentation, https://SchmidtAF.gitlab.io/stats-misc/
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=2.2
Requires-Dist: numpy<1.24,>=1.18
Requires-Dist: numba>=0.56.4
Requires-Dist: scipy>=1.5
Requires-Dist: scikit-learn>=1.4
Requires-Dist: scikit-survival>=0.24
Requires-Dist: statsmodels>=0.14
Requires-Dist: tabulate
Provides-Extra: dev
Requires-Dist: pytest>=6; extra == "dev"
Requires-Dist: pytest-mock>=3; extra == "dev"
Requires-Dist: pytest-dependency>=0.5; extra == "dev"
Requires-Dist: bump2version>=1; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: sphinx-rtd-theme; extra == "dev"
Requires-Dist: sphinx-bootstrap-theme; extra == "dev"
Requires-Dist: furo; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: notebook; extra == "dev"
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: nbsphinx-link; extra == "dev"
Requires-Dist: sphinx-argparse; extra == "dev"
Requires-Dist: numpydoc; extra == "dev"
Dynamic: license-file

# A collection of statistical functions
__version__: `0.3.5`

This repository offers a collection of Python-based statistical modules,
encompassing hypothesis testing, interval estimation, resampling methods,
regression techniques (including Firth’s logistic regression),
and selected machine learning utilities.

The documentation for stats-misc can be found [here](https://SchmidtAF.gitlab.io/stats-misc/). 


## Installation 
At present, this package is undergoing development and no packages exist yet on PyPI.
Therefore it is recommended that you install in either of the two ways below.

### Installation using conda
I maintain a conda package in my personal conda channel. To install from this please run:

```
conda install afschmidt::stats-misc
```

### Installation using pip
You can install using pip from the root of the cloned repository,
first clone and cd into the repository root:

```sh
git clone git@gitlab.com:SchmidtAF/stats-misc.git
cd stat-misc
```

Install the dependencies:

```sh
# From the root of the repository
conda env create --file ./resources/conda/envs/conda_create.yaml
```

To add to an existing environment use:

```sh
# From the root of the repository
conda env update --file ./resources/conda/envs/conda_create.yaml
```

Next the package can be installed: 

```sh
python -m pip install .
```

Or for an editable (developer) install run the command below from the root of 
the repository.
The difference with this is that you can just to a `git pull` to 
update repository, or switch branches without re-installing:

```sh
python -m pip install -e .

```
### Installation not using any conda dependencies
If you are not using conda in any way then install the dependencies via `pip` 
and install repository as an editable install also via pip:

Install dependencies:

```sh
python -m pip install --upgrade -r requirements.txt
```

Then to install repository you can either do:

```sh
python -m pip install .
```

Or for an editable (developer) install run the command below from the root of
the repository.
The difference with this is that you can just to a `git pull` to update
repository, or switch branches without re-installing:

```sh
python -m pip install -e .
```

## Next steps...
After installation, you may wish to run the included test suite with `pytest` to verify 
that the package is functioning as expected.

```sh
# From the root of the repository
pytest tests
```

## Usage

Please have a look at the examples in 
[resources](https://gitlab.com/SchmidtAF/stat-misc/-/tree/master/resources/examples)
.

