Quellcode durchsuchen

Adding use example

Andrej vor 2 Wochen
Ursprung
Commit
a1bcee7704
1 geänderte Dateien mit 32 neuen und 1 gelöschten Zeilen
  1. 32 1
      README.md

+ 32 - 1
README.md

@@ -1 +1,32 @@
-This is the code by Howard used in his study of the Three Parameter Model to personalize breast cancer screening.
+# Breast cancer screening model
+
+This is the code by Howard used in his study of the Three Parameter Model to personalize breast cancer screening.
+
+Implemented from
+
+R.Liu, Estimation of the three key parameters and the lead time distribution in lung cancer screening, PhD Thesis, 2017, University of Luisville, Luisville, Kentucky.
+
+# Usage
+
+```python
+import sys
+import os
+import numpy
+
+mPath=os.path.join('path','to','cloned','code')
+import three_parameter_screening
+#probabilty of conversion to early cancer stage per screening interval
+w=0.1
+#sensitivity of the screening exam
+beta=0.9
+#average of the exponential distribution Q of dwell time in early cancer stage, in units of screening interval
+mu=0.3
+#exponential distribution 
+def Q(t):
+   return numpy.exp(-t/mu)
+
+#screening intervals
+t=numpy.linspace(0,9,10)
+
+three_parameter_screening.probabilty_of_clinical_incidence(beta,w,mu,t,Q)
+```