Metadata-Version: 2.1
Name: related_ontologies
Version: 0.1.9
Summary: A package to generate related clinical ontologies (LOINC, SNOMED-CT)
Project-URL: Homepage, https://github.com/justin13601/related_ontologies
Project-URL: Bug Tracker, https://github.com/justin13601/related_ontologies/issues
Author-email: Justin Xu <justin13601@hotmail.com>
License: Copyright (c) 2022 The Python Packaging Authority
        
        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.
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Requires-Dist: ftfy>=6.1.1
Requires-Dist: fuzzywuzzy>=0.18.0
Requires-Dist: jaro-winkler>=2.0.0
Requires-Dist: pandas>=1.4.3
Requires-Dist: pyyaml>=6.0
Requires-Dist: scikit-learn>=1.1.1
Description-Content-Type: text/markdown

<div id="top"></div>

[![Python](https://ForTheBadge.com/images/badges/made-with-python.svg)](https://colab.research.google.com/)

[![DOI](https://zenodo.org/badge/515409655.svg)](https://zenodo.org/badge/latestdoi/515409655)



<!-- PROJECT LOGO -->
<br />
<div align="center">

  <h3 align="center">Related Clinical Ontologies</h3>

  <p align="center">
A package to suggest related clinical ontologies    <br />
    (LOINC, SNOMED-CT, etc.)
  </p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about">About</a>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#requirements">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>



<!-- ABOUT THE PROJECT -->
## About
...

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

...


<p align="right">(<a href="#top">back to top</a>)</p>


### Requirements

The package requires the following to run:

* [Pandas][pandas]~=1.4.2
* [NumPy][numpy]~=1.22.3
* [SciPy][scipy]~=1.7.3
* [Scikit-learn][sklearn]~=1.1.1
* [PyYAML][pyyaml] >= 6.0
* [Ftfy][ftfy] >= 6.1.1
* [Fuzzywuzzy][fuzzywuzzy] >= 0.18.0
* [Jaro-Winkler][jaro] >= 2.0.0

All packages are listed in ```requirements.txt```.


<p align="right">(<a href="#top">back to top</a>)</p>


### Installation
   ```sh
   pip install related_ontologies
   ```

<p align="right">(<a href="#top">back to top</a>)</p>




## Usage

```
import related_ontologies
```

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- LICENSE -->
## License

Distributed under the [MIT][mit] License.

<p align="right">(<a href="#top">back to top</a>)</p>


<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

* Alistair Johnson, DPhil | The Hospital for Sick Children

<p align="right">(<a href="#top">back to top</a>)</p>


[sklearn]: https://scikit-learn.org/stable/install.html

[pandas]: https://pandas.pydata.org/docs/getting_started/install.html

[numpy]: https://numpy.org/install/

[scipy]: https://scipy.org/install/

[ftfy]: https://pypi.org/project/ftfy/

[pyyaml]: https://pypi.org/project/PyYAML/

[fuzzywuzzy]: https://pypi.org/project/fuzzywuzzy/

[jaro]: https://pypi.org/project/jaro-winkler/

[mit]: https://opensource.org/licenses/MIT