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

Remove \dontrun{} when not strictly required #61

Merged
merged 26 commits into from
Jan 31, 2024
Merged

Remove \dontrun{} when not strictly required #61

merged 26 commits into from
Jan 31, 2024

Conversation

bahadzie
Copy link
Member

@bahadzie bahadzie commented Nov 9, 2023

Fixes #56

Bisaloo
Bisaloo requested changes Nov 15, 2023
View reviewed changes
Copy link
Member

@Bisaloo Bisaloo left a 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?

@Karim-Mane Karim-Mane self-assigned this Jan 29, 2024
@Karim-Mane Karim-Mane self-requested a review January 29, 2024 16:16
Bisaloo
Bisaloo reviewed Jan 30, 2024
View reviewed changes
Copy link
Member

@Bisaloo Bisaloo left a 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.

@Karim-Mane
Copy link
Member

@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 dontrun{}. But I realised that devtools::run_examples() flags them as not found. So I have removed them in such functions in one of the commits. Kindly let me know in case there is a workaround for this.

Bisaloo
Bisaloo reviewed Jan 31, 2024
View reviewed changes
R/read_from_fingertips.R Outdated Show resolved Hide resolved
@Karim-Mane @Bisaloo
Update R/read_from_fingertips.R
c054611 
remove @nord in the function documentation

Co-authored-by: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com>
@Karim-Mane Karim-Mane merged commit 3d715e2 into main Jan 31, 2024
7 checks passed
@Karim-Mane Karim-Mane deleted the bahadzie/issue56 branch January 31, 2024 16:45
Karim-Mane added a commit that referenced this pull request May 22, 2024
@bahadzie @Karim-Mane
@actions-user @Bisaloo
Remove \dontrun{} when not strictly required (#61)
50d5419 
* 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>
Karim-Mane added a commit that referenced this pull request May 22, 2024
@bahadzie @Karim-Mane
@actions-user @Bisaloo
Remove \dontrun{} when not strictly required (#61)
3f812ed 
* 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>
Karim-Mane added a commit that referenced this pull request Jun 10, 2024
@bahadzie @Karim-Mane
@actions-user @Bisaloo
Remove \dontrun{} when not strictly required (#61)
514f338 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bisaloo Bisaloo Bisaloo approved these changes

@Karim-Mane Karim-Mane Awaiting requested review from Karim-Mane

Assignees

@Karim-Mane Karim-Mane

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove \dontrun{} when not strictly required
4 participants
@bahadzie @Karim-Mane @Bisaloo @actions-user