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

Optional issue: examples #33

Closed
rrrlw opened this issue Dec 20, 2021 · 2 comments
Closed

Optional issue: examples #33

rrrlw opened this issue Dec 20, 2021 · 2 comments

Comments

@rrrlw
Copy link

rrrlw commented Dec 20, 2021

A comprehensive example is provided in the README. However, users of the R package would also benefit from quick access to examples in the documentation itself (i.e. using the @example or @examples Roxygen tag so that it can be accessed with ?<function name>).

If adding an example within the documentation is too complex, you can simply close this issue.

Part of this JOSS review.

@nhejazi
Copy link
Owner

nhejazi commented Dec 20, 2021

Thanks for pointing this out. As someone who does access examples through the R documentation, I agree that it would be very useful to have these for the exported functions (of which there are only 3, medoutcon, est_tml, and est_onestep). I'll add these later today and update once that has been completed.

@nhejazi
Copy link
Owner

nhejazi commented Dec 21, 2021

In 0980f97 of #34, I removed the exporting of the internal estimation functions est_tml() and est_onestep(), and I added an example based on the README to the eponymous function medoutcon(). Since this is satisfied (minimally), I'll go ahead and close the issue.

@nhejazi nhejazi closed this as completed Dec 21, 2021
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