fix: standardize stratified_sampler dist to uppercase and add verbose…#15
Merged
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
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.
Summary
Closes #5.
Addresses the documentation inconsistency Sadie flagged in
stratified_sampler(): Usage showeddist = "ev1"while Arguments described"EV1","Normal","Uniform". The function internally dispatches ontolower(dist), so both casings already worked — but the docs didn't make that clear.Changes
"EV1","Normal","Uniform"), matchingrfa_simulate()'s convention"ev1"to"EV1"so the signature matches the documentationCase-insensitivenote to the@param distdescription to acknowledge the existing toleranceverboseargument (defaultFALSE). WhenTRUE, emits acli::cli_inform()message summarizing the stratification on completionTesting
R CMD checkpasses with 0 errors, 0 warnings, 0 notes"ev1","EV1","Normal", and an invalid valuerfa_simulate()—verbosedefaults toFALSE, and the internaltolower()dispatch was already present