Rv/refactor create metrics #16
Open
Conversation
This file contains hidden or 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
Allow users to directly pass documentation in the function instead of having to put it in an rmd_file. Use sensible defaults for all documentation fields.
|
/style |
…metrics into rv/refactor-create-metrics
1. switch from nest_legacy -> nest 2. check if running in interactive mode
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.
@dgrtwo This PR provides sensible defaults for all documentation fields and optionally allows users to provide them as arguments to
create_metrics. Here are some key features:titleanddescriptionautomatically default to the name of themetricordimension. We could usesnakecasetransformations for defaults that work better withshinymetrics.categoryandsubcategorydefault to""as they are used downstream by other functions inshinymetricslikemetric_explorer. In the event, they equal"", they are not used to generatemetric_full. Ideally, I would like to make both of these required parameters with better defaults. This is key to being able to do neat things like themetric_explorer.I still need to add tests that test this part of the flow.