Metadata-Version: 2.1
Name: censoredsummarystats
Version: 0.0.1
Summary: A python package for calculating summary stats on censored data (data that contains < and > symbols).
Home-page: https://github.com/kurtvanness/CensoredSummaryStats
License: Apache-2.0
Author: Kurt van Ness
Author-email: vanness.kurt@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: numpy (>=1.24.2,<2.0.0)
Project-URL: Repository, https://github.com/kurtvanness/CensoredSummaryStats
Description-Content-Type: text/markdown

# censoredsummarystats
A repository that contains functions for calculating summary stats on censored data.

## Functions
Current functions include maximum, minimum, average, percentile, median (same as 50th percentile).

All functions require a dataframe that contains a column of results. This package is only useful when the results are written as strings that cannot be directly converted to a numeric datatype due to the presence of symbols that indicate the result is potentially above or below a particular value. The accepted censorship symbols include (<,≤,≥,>).

Additional table columns can be provided as a list so that the statistical functions obtain results for groups of results.

More options are available and described within each function.

