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

Closes #2388 numeric country decodes #2419

Merged
merged 17 commits into from
May 23, 2024
Merged

Closes #2388 numeric country decodes #2419

merged 17 commits into from
May 23, 2024

Conversation

jeffreyad
Copy link
Collaborator

@jeffreyad jeffreyad commented Apr 25, 2024 •
edited

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update)
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF version of it to the same folder.
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiral (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package()
  • Run R CMD check locally and address all errors and warnings - devtools::check()
  • Link the issue in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@jeffreyad jeffreyad linked an issue Apr 25, 2024 that may be closed by this pull request
Feature Request: Add numeric decodes for COUNTRY #2388
Closed
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 25, 2024 •
edited

Code Coverage

Package Line Rate Health
admiral 97% ✔
Summary 97% (4685 / 4813) ✔

manciniedoardo
manciniedoardo requested changes Apr 26, 2024
View reviewed changes
NEWS.md Outdated Show resolved Hide resolved
R/create_country_codes.R Outdated Show resolved Hide resolved
@millerg23
Copy link
Collaborator

I think we have 2 other possible solutions for storing the country codes:

  1. Have a function called get_country_codes with the tibble inside it, then user can define the name of the dataset or call the function directly ie. dataset_add = get_country_codes().
  2. We store the dataset in data folder with r script that creates it stored in a sub-folder of inst (data.R would need updated also).

I don't think we have any other scripts that creates a dataset directly, like this does. So would be good to be consistent how we create what is essentially metadata?

@bundfussr
Copy link
Collaborator

I think we have 2 other possible solutions for storing the country codes:

  1. Have a function called get_country_codes with the tibble inside it, then user can define the name of the dataset or call the function directly ie. dataset_add = get_country_codes().
  2. We store the dataset in data folder with r script that creates it stored in a sub-folder of inst (data.R would need updated also).

I don't think we have any other scripts that creates a dataset directly, like this does. So would be good to be consistent how we create what is essentially metadata?

Usually, datasets are stored in data and the scripts which create them should be stored in data-raw. Unfortunately, we are not following this convention. I would discuss it at the next meeting.

jeffreyad and others added 4 commits April 26, 2024 08:02
@jeffreyad @manciniedoardo
Update NEWS.md
00e9ee3 
Co-authored-by: Edoardo Mancini <53403957+manciniedoardo@users.noreply.github.com>
@jeffreyad @manciniedoardo
Update R/create_country_codes.R
555bbca 
Co-authored-by: Edoardo Mancini <53403957+manciniedoardo@users.noreply.github.com>
Run styler on vignette and update Turkey name for non ascii characters
163db04
Update documentation
a4452a2
@jeffreyad
Copy link
Collaborator Author

I think we have 2 other possible solutions for storing the country codes:

  1. Have a function called get_country_codes with the tibble inside it, then user can define the name of the dataset or call the function directly ie. dataset_add = get_country_codes().
  2. We store the dataset in data folder with r script that creates it stored in a sub-folder of inst (data.R would need updated also).

I don't think we have any other scripts that creates a dataset directly, like this does. So would be good to be consistent how we create what is essentially metadata?

Thanks @millerg23 and @bundfussr, I noticed dose_freq_lookup in create_single_dose_dataset() creates a tibble in this way. But I agree they should be consistent.

bms63
bms63 approved these changes May 10, 2024
View reviewed changes
Copy link
Collaborator

@bms63 bms63 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

bundfussr
bundfussr reviewed May 13, 2024
View reviewed changes
NEWS.md Outdated Show resolved Hide resolved
R/create_country_codes.R Show resolved Hide resolved
Jeffrey Dickinson and others added 2 commits May 16, 2024 18:10
Calculate number by order
b48c1fb
@jeffreyad @bundfussr
Update NEWS.md
183de4c 
Co-authored-by: Stefan Bundfuss <80953585+bundfussr@users.noreply.github.com>
bms63
bms63 reviewed May 21, 2024
View reviewed changes
R/create_country_codes.R
#' `country_number` is the numeric code corresponding to an alphabetic sorting of
#' the 3-letter codes.
#'
#' To see the entire table in the console, run `print(country_code_lookup)`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice tip!!

bms63
bms63 reviewed May 21, 2024
View reviewed changes
R/create_country_codes.R Outdated
#' library(lubridate)
#'
#' # Create reference dataset for periods
#' adsl <- tribble( #' adsl <- tribble(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is a wayward #' in here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jeffreyad could you check on this example? Is the #' needed? after that we can merge

@bms63 bms63 merged commit 648bdab into main May 23, 2024
16 checks passed
@bms63 bms63 deleted the 2388_numeric_country_decodes branch May 23, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bms63 bms63 bms63 approved these changes

@manciniedoardo manciniedoardo manciniedoardo approved these changes

@bundfussr bundfussr bundfussr approved these changes

@kaz462 kaz462 Awaiting requested review from kaz462

@millerg23 millerg23 Awaiting requested review from millerg23

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature Request: Add numeric decodes for COUNTRY
5 participants
@jeffreyad @millerg23 @bundfussr @bms63 @manciniedoardo