Prepare Release 1.0.0: Check {insight} API / documentation on API

[strengejacke]

Fixes #937

TODO

• Convert RE variances from cov to cor/sd bayestestR#536
• We need to allow methods for find_statistic(), so other can add their classed.
• Discrepancy in residual variance between VarCorr() and get_variance_residual() #929
• Export get_dispersion() #634

Anything else?

[strengejacke]

Tagging @vincentarelbundock - we're preparing some stable 1.0.0 releases in the near future. Anything in the API design or urgent features that should be taken into account for that release?

[vincentarelbundock]

Everything is fine for me, thanks for the tag!

Stable release is an excellent idea. Great news!

[codecov]

Codecov Report

Attention: Patch coverage is 82.81250% with 11 lines in your changes missing coverage. Please review.

Project coverage is 57.23%. Comparing base (ad16942) to head (8709789).
Report is 135 commits behind head on main.

Files with missing lines	Patch %	Lines
R/validate_argument.R	86.79%	7 Missing ⚠️
R/clean_parameters.R	50.00%	3 Missing ⚠️
R/get_auxiliary.R	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #938      +/-   ##
==========================================
+ Coverage   55.75%   57.23%   +1.47%     
==========================================
  Files         125      126       +1     
  Lines       15514    16089     +575     
==========================================
+ Hits         8650     9208     +558     
- Misses       6864     6881      +17     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.