The default regression argument of zepid.base.interaction_contrast_ratio differs from the description in the documentation.

[    if regression == 'logit':](https://github.com/pzivich/zEpid/blob/16a0f96f8b2c65df8715085801f21757d1478e1e/zepid/base.py#L1658)
It's strange that the default argument will cause warning, 
```
    if regression == 'logit':
        f = sm.families.family.Binomial()
        warnings.warn('Using the Odds Ratio to calculate the ICR is only valid when the OR approximates the RR',
                      UserWarning)
    elif regression == 'log':
        f = sm.families.family.Binomial(sm.families.links.log())
    else:
        raise ValueError("Either 'logit' or 'log' must be specified for the regression parameter")
```

And the docs here
[regression (string, optional) – Type of regression model to fit. Default is ‘log’ which fits the log-binomial model. Options include: * ‘log’ Log-binomial model. Estimates the Risk Ratio * ‘logit’ Logistic model. Estimates Odds Ratio. Only valid when odds ratio approximates the risk ratio](https://zepid.readthedocs.io/en/latest/Reference/generated/zepid.base.interaction_contrast_ratio.html#:~:text=regression%20(string%2C%20optional)%20%E2%80%93%20Type%20of%20regression%20model%20to%20fit.%20Default%20is%20%E2%80%98log%E2%80%99%20which%20fits%20the%20log%2Dbinomial%20model.%20Options%20include%3A%20*%20%E2%80%98log%E2%80%99%20Log%2Dbinomial%20model.%20Estimates%20the%20Risk%20Ratio%20*%20%E2%80%98logit%E2%80%99%20Logistic%20model.%20Estimates%20Odds%20Ratio.%20Only%20valid%20when%20odds%20ratio%20approximates%20the%20risk%20ratio)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The default regression argument of zepid.base.interaction_contrast_ratio differs from the description in the documentation. #174

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development