Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optimization method options should be better documented #140

Open
willwerscheid opened this issue Mar 13, 2024 · 4 comments
Open

optimization method options should be better documented #140

willwerscheid opened this issue Mar 13, 2024 · 4 comments

Comments

@willwerscheid
Copy link
Contributor

even a basic description of what the options mean would be helpful; at present there is nothing

@pcarbo
Copy link
Collaborator

pcarbo commented Mar 13, 2024

@willwerscheid I pushed a couple commits. How's this?

optmethod: The method used to compute maximum-likelihood estimates of the mixture weights. The default setting,
“mixSQP”, uses the fast sequential quadratric programming (SQP) method implemented in the mixsqp package.
Alternative methods include the interior-point method implemented in the REBayes package (optmethod = "mixIP"),
and a simple Expectation Maximization (EM) algorithm (optmethod = "mixEM"). For more details on the different
options, see the help for functions estimate_mixprop, mixSQP, mixIP, mixEM, w_mixEM and mixVBEM.

@pcarbo
Copy link
Collaborator

pcarbo commented Mar 13, 2024

@stephens999 Your review on this change is welcome, but not necessary.

@willwerscheid
Copy link
Contributor Author

@pcarbo Looks great! Those functions mentioned at the end are all linked, correct?

@pcarbo
Copy link
Collaborator

pcarbo commented Mar 13, 2024

They should be, yes. You can reinstall the package if you want to check this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants