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

documenting predict/plot/etc. methods #13

Open
bbolker opened this issue Dec 4, 2022 · 3 comments
Open

documenting predict/plot/etc. methods #13

bbolker opened this issue Dec 4, 2022 · 3 comments

Comments

@bbolker
Copy link
Collaborator

bbolker commented Dec 4, 2022

This is a long-standing issue of mine with S4 methods: it's pretty hard for a user (or at least me) to guess where we should be looking for documentation for, say, the predict() or plot() method for fitode objects. In fact the answers are help("predict,fitode-method)") and help("plot,fitode,missing-method") (the latter means "the method for plot when the function signature is {fitode,missing} - ugh).

I would suggest adding an alias to each of these so that predict.fitode and plot.fitode will find the relevant help pages, even thought these aren't S3 methods ...

@davidearn
Copy link
Collaborator

I'm glad it's not just me that finds this issue annoying. I like the idea of S3-style aliases. In fact, I tried ?plot.fitode the other day, knowing this is an S4 pkg but thinking maybe you'd have done that :)

@parksw3
Copy link
Owner

parksw3 commented Dec 5, 2022

Will work on adding aliases and better documentation

@parksw3
Copy link
Owner

parksw3 commented Dec 6, 2022

OK so I added aliases to most (all?) methods. I also added methods documentation to class objects, which seemed more appropriate (and consistent with mle2).

So if you do ?fitode it'll take you to fitode-class and ?fitode-class now has a new section called methods. The same goes for fitodeMCMC. Can close this issue if either/both of you are happy with the documentation in ?fitode-class.

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

3 participants