722 show estimated parameter uncertainties or not

[OnnoEbbens]

Short Description

Remove the estimated parameter uncertainties from the fit report and the model results plot by default. Add an optional argument to include the parameter uncertainties in both.

The estimated parameter uncertainties are only accurate estimates if some conditions are met. This is described in this notebook: https://pastas.readthedocs.io/en/master/examples/diagnostic_checking.html. To avoid people using the uncertainties while they are not accurate we remove them by default from some visuals.

Checklist before PR can be merged:

• closes issue Show estimated parameter uncertainties or not #722
• is documented
• Format code with Black formatting
• type hints for functions and methods
• tests added / passed

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
❌ -0.27% (target: +0.00%)	✅ 55.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (3189a40)	5999	4484	74.75%
Head commit (ba47e82)	6009 (+10)	4475 (-9)	74.47% (-0.27%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#729)	20	11	55.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
❌ +0.00% (target: +0.00%)	✅ 73.91%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (bf64e28)	6163	4647	75.40%
Head commit (8ceb605)	6191 (+28)	4668 (+21)	75.40% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#729)	23	17	73.91%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

[mbakker7]

Looks good. Should be rebased after PR723 is merged.

[rubencalje]

Maybe it is better to rename "par_uncertainty" to "stderr" or "par_stderr"?

[dbrakenhoff]

or just write it out entirely :)? parameter_stderr

[OnnoEbbens]

I renamed it to stderr

[mbakker7]

If I am not mistaken, none of the examples in the docs now show the stderr. But there are a few notebooks where we check the diagnostics. Those would be good notebooks to modify and show that the stderr can added (and the good workflow is then to do a diagnostics check first).

[OnnoEbbens]

You are correct, I've added the standard errors to the diagnostics and uncertainty notebooks. The standard error is also mentioned in the 'adding_trends' notebook (https://pastas.readthedocs.io/en/master/examples/adding_trends.html) for drawing a confidence interval. I don't think we have to add the standard error to the other plot in this notebook and we can leave it as is. The only thing that bothered me in the trends notebook is that I don't see the confidence interval in the plot but that is another issue

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.09% (target: +0.00%)	✅ 75.00%

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (bf64e28)	6163	4647	75.40%
Head commit (c1e84d1)	6189 (+26)	4672 (+25)	75.49% (+0.09%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#729)	24	18	75.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation}

[raoulcollenteur]

I think there are a couple more notebook where we can show the stderr. I know that for recharge estimation this is possible. I'll have a look at that after merging PR #678 . Otherwise I think this looks good!