Metadata-Version: 2.1
Name: mtbp3Lab
Version: 0.1.1
Summary: my lab notes
License: GNU General Public License v3.0
Author: Y. Hsu
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Provides-Extra: docs
Requires-Dist: pandas (>=2.0.0,<3.0.0)
Requires-Dist: seaborn (>=0.13.2,<0.14.0)
Description-Content-Type: text/markdown

# mtbp3

![PyPI](https://img.shields.io/pypi/v/mtbp3Lab?label=pypi%20package)
![PyPI - Downloads](https://img.shields.io/pypi/dm/mtbp3Lab)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Tests Status](./_static/reports/junit/tests-badge.svg?dummy=8484744)](./_static/reports/junit/report.html)
[![Coverage Status](./_static/reports/coverage/coverage-badge.svg?dummy=8484744)](./_static/reports/coverage/coverage.xml)

My lab notes in Python.

Functions are grouped into:

- StatLab<sup>*</sup>: 
  - Correlation: `statlab.corr` 
  - Reliability: `statlab.kappa`

<sup>*</sup> Documents are not executed while building.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license) 
- [Credits](#credits) 
- [How to Cite](#how-to-cite) 

## Installation

Instructions on how to install the project and its dependencies.

```bash
$ pip install mtbp3Lab
```

## Usage

Below is an example of showing the version of currently installed package:

``` 
import mtbp3Lab
print(mtbp3.__version__)
``` 

Please find more examples from the link [here](https://yh202109.github.io/mtbp3Lab/index.html).

## Contributing

Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.

## License

`mtbp3Lab` was created by Y. Hsu. It is licensed under the terms of the GNU General Public License v3.0 license.

## Credits

Documentation: 

- Documents were initially created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
- Version badges are provided by: https://img.shields.io/pypi
- Tests badges were generated by: https://smarie.github.io/python-genbadge/

## How to Cite 

Hsu, Y. (2024). mtbp3Lab: My lab notes in Python [Software]. Retrieved from https://yh202109.github.io/mtbp3Lab/index.html.

```
@software{mtbp3,
  author = {Hsu, Y.},
  title = {mtbp3Lab: My lab notes in Python},
  year = {2024},
  url = {https://yh202109.github.io/mtbp3Lab/index.html},
  note = {Software}
}
```

