joint significant test

[Shunsenhuang-123]

• Specification Curve version:
• Python version:
• Operating System:

Description

Dear aeturrell,
Is there any functions which may help to conduct "joint significance test" in this packages?
And is there any document that help to discribe the uses of each function?
Thank you!

What I Did

Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.

[aeturrell]

Thanks for submitting the first non-author issue for specification curve! 🎉

1. I think adding the results of an F-statistic somewhere make sense. Definitely it should be in the dataframe of results that is created when you perform fit, eg

sc.fit()
sc.df_r

with df_r including an F statistic for each specification. But would it add value to have it displayed in the plots somewhere too? If you can give an example of what the functionality is that you'd like to see, that would be really helpful.

2. Unfortunately the documentation is a work in progress that I can only return to in dribs and drabs when I have time.. I'd be delighted to get pull requests that added doc strings or better documentation (see the contribution guidelines for how to do this). However, if there's a specific part of the documentation that you need better clarity on, please let me know and I will ensure that it is addressed first.