search

khliland / pls

The pls R package
36 stars 3 forks source link

Help function #5

Closed hcpetersen closed 5 years ago

hcpetersen commented 5 years ago

Dear Authors of pls, May I suggest that you add information on the option maxit to the help function for mvr (plsr, etc). Best Hans

bhmevik commented 5 years ago

Thanks for the suggestion! I'll have to think a little about how that could be done. The thing is that "maxit" and "tolerance" are not arguments of mvr() or plsr(), but of some of the underlying fit functions (oscorespls.fit and widekernelpls.fit), so just adding them amongst the arguments in the mvr help page will give an error when checking the package for submission to CRAN. I'll have to check if there are other ways of mentioning them there, or whether it is best to make them arguments of mvr() directly. (There is the same consideration for other functions that are not usually called directly, like mvrCv().)

bhmevik commented 5 years ago

I've added these arguments in the documentation of the "..." argument. See pull request #7 . It is not optimal, but I didn't want to promote all those arguments to the mvr() function; it already has enough arguments. :)