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.

Sign up for GitHub

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

Jump to bottom

Check that all exported functions have @return and @examples #125

Open
Tracked by #117
TNRiley opened this issue Apr 12, 2023 · 5 comments
Open
Tracked by #117

Check that all exported functions have @return and @examples #125

TNRiley opened this issue Apr 12, 2023 · 5 comments
Assignees
@DrMattG @kaitlynhair @TNRiley
Labels
Documentation Improvements or additions to documentation Help wanted Extra attention is needed
Milestone
MVP

Comments

@TNRiley
Copy link
Collaborator

TNRiley commented Apr 12, 2023

No description provided.

@TNRiley TNRiley mentioned this issue Apr 12, 2023
Open
27 tasks
@TNRiley TNRiley added Documentation Improvements or additions to documentation Help wanted Extra attention is needed labels Apr 12, 2023
@TNRiley TNRiley added this to the MVP milestone Apr 12, 2023
@TNRiley
Copy link
Collaborator Author

TNRiley commented Apr 12, 2023

@DrMattG @kaitlynhair @LukasWallrich - I've been working on the @examples and have made a lot of progress, but am still not 100% on @examples - specifically, which functions are required to have them (plots/tables?) Just looking for a little assistance or a review of what I've added thus far. Thanks :)

@DrMattG
Copy link
Collaborator

DrMattG commented Apr 13, 2023

Added example to tables.R - I think these are useful as interactive examples (but happy whatever way!). I think it is useful to have example code for all external (exported) functions

@TNRiley
Copy link
Collaborator Author

TNRiley commented Apr 20, 2023 •
edited

@DrMattG will add the data - check the plots examples @TNRiley - technically ok, but want to use real data

@TNRiley
Copy link
Collaborator Author

TNRiley commented Apr 20, 2023

@TNRiley remove if interactive from any functions that need to be displayed, keep for reading/writing functions

@TNRiley
Copy link
Collaborator Author

TNRiley commented Apr 24, 2023

Will need to wait for #86 to be completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DrMattG DrMattG

@kaitlynhair kaitlynhair

@TNRiley TNRiley

Labels
Documentation Improvements or additions to documentation Help wanted Extra attention is needed
Projects
None yet
Milestone
MVP
Development

No branches or pull requests
3 participants
@DrMattG @kaitlynhair @TNRiley