Metadata-Version: 2.1
Name: ErrorFieldConcordance
Version: 0.1
Summary: Calculation of trending concordance between two measures using the Error Field method
Author: Ishita Srivastava, Brandon Woo
Author-email: Joe Rinehart <jrinehar@hs.uci.ed>, Bernd Saugel <b.saugel@uke.de>, Sean Coeckelenbergh <seancoeck@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.0
Description-Content-Type: text/markdown
License-File: LICENSE

# ErrorFieldConcordance

Package providing calculation of trending concordance between two measures using the Error Field method and optional graphing.

This package requires numpy and matplotlib.

## Function Call
After importing the package, the method can be called as below:

```Concordance = ErrorFieldConcordance(X,Y,plot_TF=False,graph_label="",
                          XMeasName="ΔX (LPM)",
                          YMeasName="ΔY (LPM)")
```

The concordance value is a number in the range of \[-1,1\].  Values close to 1 indicate strong concordance.  Values close to -1 indicate strong negative concordance (i.e. the measures tend to move in the opposite direction of one another). Values near 0 suggest independence of the two measures. 

Function Parameters:
+The X and Y parameters are lists or arrays of equal size corresponding to paired measures to be compared.
+plot_TF is a boolean that controls whether or not a figure is created
+graph_label is an optional parameter to be prefixed to the graph title
+X and YMeasName are used to customize the X and Y graph labels


## Citing
Please cite this package using the following:

*PubMed Reference & Citation TBD*
