stats-misc 0.3.5__tar.gz

stats_misc-0.3.5/LICENSE

@@ -0,0 +1,17 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+Copyright (C) 2024  Amand Floriaan Schmidt (amand.schmidt@ucl.ac.uk)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

stats_misc-0.3.5/PKG-INFO

@@ -0,0 +1,143 @@
+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)
+.
+

stats_misc-0.3.5/README.md

@@ -0,0 +1,100 @@
+# 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)
+.
+

stats_misc-0.3.5/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "stats-misc"
+version = "0.3.5"
+description = "Statistical functions not included by canonical Python analytical packages."
+readme = "README.md"
+requires-python = ">=3.11, <3.13"
+license = "GPL-3.0-or-later"
+license-files = ["LICENSE"]
+authors = [
+  {name = "Amand Floriaan Schmidt", email = "floriaanschmidt@gmail.com" }
+]
+dynamic = ["dependencies", "optional-dependencies"]
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: PyPy"
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/SchmidtAF/stats-misc"
+Documentation = "https://SchmidtAF.gitlab.io/stats-misc/"
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies.dev = {file = ["requirements-dev.txt"]}
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["stats_misc*"]
+exclude = ["tests", "*.tests", "*.tests.*", "tests.*"]
+
+[tool.setuptools.package-data]
+"stats_misc" = ["*.md", "*.txt", "*.rst", "example_data/example_datasets/*.tsv.gz"]
+
+[tool.setuptools.exclude-package-data]
+"*" = ["tests/*"]
+
+[tool.pytest.ini_options]
+markers = [
+    "datafiles: load datafiles"
+]
+testpaths = ["tests"]
+

stats_misc-0.3.5/requirements-dev.txt

@@ -0,0 +1,21 @@
+# testing
+pytest>=6
+pytest-mock>=3
+pytest-dependency>=0.5
+
+# dev tooling
+bump2version>=1
+jupyter
+build
+twine
+
+# documentation
+sphinx-rtd-theme
+sphinx-bootstrap-theme
+furo
+myst-parser
+notebook
+nbsphinx
+nbsphinx-link
+sphinx-argparse
+numpydoc

stats_misc-0.3.5/requirements.txt

@@ -0,0 +1,8 @@
+pandas>=2.2
+numpy>=1.18, <1.24
+numba>=0.56.4
+scipy>=1.5
+scikit-learn>=1.4
+scikit-survival>=0.24
+statsmodels>=0.14
+tabulate

stats_misc-0.3.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stats_misc-0.3.5/stats_misc/__init__.py

@@ -0,0 +1 @@
+from ._version import __version__

stats_misc-0.3.5/stats_misc/_version.py

@@ -0,0 +1 @@
+__version__ = '0.3.5'