Simplify parameter conversion #165
Merged
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
This was referenced Aug 22, 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.
This PR addresses #164.
This PR reduces the number of exported parameter conversion functions to two. This is done by removing the one-to-one conversion functions, for example
lnorm_meansd2meanlogsdlog()and consolidating all of their functionality with that of the many-to-one (e.g.convert_lnorm_summary_stats()) and one-to-many (e.g.convert_lnorm_params()) conversion functions into two functions. One to convert from parameters to summary statistics (convert_params()) and one from summary statistics to parameters (convert_summary_stats()).The vignette on parameter conversion and extraction has been heavily modified to work with the new functions, it contains the same examples but uses fewer functions to do so. The getting started vignette has been updated to removed mention of the old functions and use the newer versions.
Documentation and testing has been updated with the changes made in this PR.
calc_dist_params()has also been moved from exported to internal.