Skip to content

help.zelig needs some attention #43

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

Open
izahn opened this issue Jan 26, 2013 · 1 comment
Open

help.zelig needs some attention #43

izahn opened this issue Jan 26, 2013 · 1 comment

Comments

@izahn
Copy link

izahn commented Jan 26, 2013

This bug report applies to Zelig Version 4.1-2 on Linux.

The zelig function documentation says "Type ‘help.zelig("models")’
to see a list of currently supported models" but

help.zelig("models")

returns "no vignettes found". This is because the doc/index.html file is empty, but I guess this strategy will not work with the new system of splitting Zelig into ZeligGAM ZeligMixed etc. anyway.

The documentation includes list.zelig.models but

list.zelig.models()

returns 'Error: could not find function "list.zelig.models"' because this function is not exported. The list of models available can be obtained with

Zelig:::list.zelig.models()

so perhaps it will be useful to export this function, or modify help.zelig so that it calls this function instead of

print(do.call("vignette", list(package = "Zelig")))

as is currently done.

@izahn
Copy link
Author

izahn commented Jan 26, 2013

As I've been thinking about this I realized I don't understand the purpose of help.zelig. Why rewrite the help function? What is help.zelig actually supposed to do that help() doesn't already do? If the purpose is to document zelig models I think this should be done in the zelig function help page (vignettes can be linked from there).

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

1 participant