Closes #1698 1698_update_restrict)derivation_doc: Update description of derivation argument
#1744
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
bms63
reviewed
Feb 14, 2023
R/call_derivation.R
Outdated
Comment on lines
8
to
13
| #' | ||
| #' A function is expected. The function must provide the `dataset` argument | ||
| #' and all arguments specified in the `params()` objects passed to the | ||
| #' `variable_params` and `...` argument. Therefore it is not possible to | ||
| #' specify dplyr functions like `mutate()` or `summarize()`. | ||
| #' |
There was a problem hiding this comment.
Suggested change
| #' | |
| #' A function is expected. The function must provide the `dataset` argument | |
| #' and all arguments specified in the `params()` objects passed to the | |
| #' `variable_params` and `...` argument. Therefore it is not possible to | |
| #' specify dplyr functions like `mutate()` or `summarize()`. | |
| #' | |
| #' | |
| #' A function is expected. The function must provide the `dataset` argument | |
| #' and all arguments specified in the `params()` objects passed to the | |
| #' `variable_params` and `...` argument. Therefore, it is not possible to | |
| #' specify `{dplyr}` functions like `mutate()` or `summarize()`. | |
| #' |
There was a problem hiding this comment.
Maybe Therefore is the wrong word?? Perhaps Please Note
bms63
reviewed
Feb 14, 2023
R/slice_derivation.R
Outdated
Comment on lines
11
to
15
| #' A function is expected. The function must provide the `dataset` argument | ||
| #' and all arguments specified in the `params()` objects passed to the `arg` | ||
| #' argument. Therefore it is not possible to specify dplyr functions like | ||
| #' `mutate()` or `summarize()`. | ||
| #' |
bms63
reviewed
Feb 14, 2023
| @@ -6,6 +6,11 @@ | |||
| #' | |||
| #' @param derivation Derivation | |||
There was a problem hiding this comment.
What is a Derivation? Could we say something about how the function is performing the derivation. I know what this is doing I just think a new user might be confused
There was a problem hiding this comment.
Good point! I have added a short definition. Does it make sense?
I have also added it to the "Get Started" page.
In principle a glossary would be nice but hard to realize in R documentation.
There was a problem hiding this comment.
Omg a glossary would be fantastic. I'm making an issue for this lol.
bms63
reviewed
Feb 14, 2023
R/restrict_derivation.R
Outdated
Comment on lines
9
to
12
| #' A function is expected. The function must provide the `dataset` argument | ||
| #' and all arguments specified in the `params()` objects passed to the `arg` | ||
| #' argument. Therefore it is not possible to specify dplyr functions like | ||
| #' `mutate()` or `summarize()`. |
There was a problem hiding this comment.
Suggested change
| #' A function is expected. The function must provide the `dataset` argument | |
| #' and all arguments specified in the `params()` objects passed to the `arg` | |
| #' argument. Therefore it is not possible to specify dplyr functions like | |
| #' `mutate()` or `summarize()`. | |
| #' An `{admiral}` function that performs a specific derivation is expected. The function must | |
| # ' provide the `dataset` argument | |
| #' and all arguments specified in the `params()` objects passed to the `arg` | |
| #' argument. Please note, it is not possible to specify `{dplyr}` functions like | |
| #' `mutate()` or `summarize()`. |
There was a problem hiding this comment.
I would not restrict to "admiral" because a derivation could be implemented in TA, company, or study specific admiral packages.
bms63
approved these changes
Feb 15, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
… argument
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
develbranch until you have checked off each task.styler::style_file()to style R and Rmd filesdevtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdif the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers)pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()R CMD checklocally and address all errors and warnings -devtools::check()