sympto
v3.0.2
Published
Apply the sympto-thermal method to cycle data
Downloads
154
Readme
Sympto
Accepts an array of cycle days (one cycle) and returns the symptothermal status for that cycle. Run node example.js
for a demo.
Find out more about the symptothermal method (in German).
Usage
Pass in all necessary info as an object with the following properties:
- cycle: An array of the cycle's days in object form. See these assertions for how to format them.
- previousCycle (optional): Same format as cycle. Sympto must be able to detect ovulation in the previous cycle in order to detect a pre-ovulatory phase.
- earlierCycles (optional): Needed to correctly determine pre-ovulatory phase length.
- secondarySymptom (default:
mucus
): Determines which values are used for symptothermal evaluation, can be'mucus'
or'cervix
. - excludePreOvu (default:
false
): Pass in true if you don't want the pre-ovulatory phase to be included in the status.