-
Notifications
You must be signed in to change notification settings - Fork 5
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
Remove \dontrun{} when not strictly required #61
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My point in #56 was not to suggest removing examples but to ensure examples are run wherever possible.
Could you update this accordingly please?
303c59a
to
9d32ffb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't completely follow what happened here. It looks like files were updated unconsistently: some have their examples removed, other now have noRd
.
Instead, could you:
- keep all examples
- review all dontrun examples to ensure they only concern examples with internet requests.
If the two points above had already been addressed in other PRs in the meantime, this PR should be closed.
9a943fb
to
d75d396
Compare
@Bisaloo - I have restored the removed examples. the @nord were there before we removed them in a branch that is already merged into main. I have resolved them now. I tried to add examples for internal functions that do not need |
remove @nord in the function documentation Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
* add the examples to the functions documentations * build documentation for show_tables() and visualise_table() * Update CITATION.cff * update function's examples * fix linters * add new lines * remove unnecessary nolint * use explicit URL * update show_example_file documentation * align argument in function documentation * Automatic readme update * add examples and remove dontrun{} when not needed in DHIS2 related functions * add examples and remove dontrun{} when not needed in Fingertips related functions * add examples and remove dontrun{} when not needed in REDCap related functions * add examples and remove dontrun{} when not needed in server related functions * add examples and remove dontrun{} when not needed in readepi related functions * run devtools::document() * remove README.html * rearrange arguments in read_from_readcap example * complete test example for dhis2_get_attributes_from_user * Update _pkgdown.yml to account for read_from_fingertips * update on dhis2_get_attributes_from_user() * Update CITATION.cff * remove examples in internal functions documentation - for functions without dontrun{} * Update R/read_from_fingertips.R remove @nord in the function documentation Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com> --------- Co-authored-by: Karim-Mane <karimanee@outlook.com> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: Karim MANE <84502011+Karim-Mane@users.noreply.github.com> Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
* add the examples to the functions documentations * build documentation for show_tables() and visualise_table() * Update CITATION.cff * update function's examples * fix linters * add new lines * remove unnecessary nolint * use explicit URL * update show_example_file documentation * align argument in function documentation * Automatic readme update * add examples and remove dontrun{} when not needed in DHIS2 related functions * add examples and remove dontrun{} when not needed in Fingertips related functions * add examples and remove dontrun{} when not needed in REDCap related functions * add examples and remove dontrun{} when not needed in server related functions * add examples and remove dontrun{} when not needed in readepi related functions * run devtools::document() * remove README.html * rearrange arguments in read_from_readcap example * complete test example for dhis2_get_attributes_from_user * Update _pkgdown.yml to account for read_from_fingertips * update on dhis2_get_attributes_from_user() * Update CITATION.cff * remove examples in internal functions documentation - for functions without dontrun{} * Update R/read_from_fingertips.R remove @nord in the function documentation Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com> --------- Co-authored-by: Karim-Mane <karimanee@outlook.com> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: Karim MANE <84502011+Karim-Mane@users.noreply.github.com> Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
* add the examples to the functions documentations * build documentation for show_tables() and visualise_table() * Update CITATION.cff * update function's examples * fix linters * add new lines * remove unnecessary nolint * use explicit URL * update show_example_file documentation * align argument in function documentation * Automatic readme update * add examples and remove dontrun{} when not needed in DHIS2 related functions * add examples and remove dontrun{} when not needed in Fingertips related functions * add examples and remove dontrun{} when not needed in REDCap related functions * add examples and remove dontrun{} when not needed in server related functions * add examples and remove dontrun{} when not needed in readepi related functions * run devtools::document() * remove README.html * rearrange arguments in read_from_readcap example * complete test example for dhis2_get_attributes_from_user * Update _pkgdown.yml to account for read_from_fingertips * update on dhis2_get_attributes_from_user() * Update CITATION.cff * remove examples in internal functions documentation - for functions without dontrun{} * Update R/read_from_fingertips.R remove @nord in the function documentation Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com> --------- Co-authored-by: Karim-Mane <karimanee@outlook.com> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: Karim MANE <84502011+Karim-Mane@users.noreply.github.com> Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
Fixes #56