search

r-devel / r-dev-day

Repo to organize tasks for R Dev Days
7 stars 2 forks source link

Bug 18173: Man page for lm.fit is very brief about the circumstances when to use #41

Open shannonpileggi opened 3 months ago

shannonpileggi commented 3 months ago

Bug 18173: Man page for lm.fit is very brief about the circumstances when to use

Suggestion

?lm.fit is very brief about when to use vs. lm() and vs. .lm.fit.

We see comments like:
"These should usually not be used directly unless by experienced users." and "... for even more experienced users."

Would it be possible to have a little more information what prequisites for a save use of lm.fit() and .lm.fit() are?

What TIBO writes for their enterprise runtime for R in ?lm.fit under "Details" seems to apply to R as well (did not check for all the details provided there): https://docs.tibco.com/pub/enterprise-runtime-for-R/4.3.1/doc/html/Language_Reference/stats/lm.fit.html

Maybe two or three examples would also help to hightlight the differences of lm(), lm.fit(), and .lm.fit().
hollyyfc commented 3 months ago

Alan and Holly have replied to the original issue report on Bugzilla. Refer to the details there.