Refactor SurveyDesign and add in-place constructor #320
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
This commit introduces a significant refactor to the `SurveyDesign` struct in the `SurveyDesign.jl` file. A new in-place constructor function, `SurveyDesign!`, has been added to allow for direct manipulation of the passed `AbstractDataFrame`. This change aims to enhance the flexibility and efficiency of survey design creation by providing an option to modify the data frame in place. Additionally, minor formatting adjustments were made to improve code readability and consistency across the file. These include alignment of default parameter values and minor adjustments to spacing and line breaks. The introduction of the `SurveyDesign!` function follows the Julia convention of using the `!` suffix to indicate functions that modify their arguments in place. This change is expected to make the API more intuitive for users familiar with Julia conventions. Overall, this refactor and the addition of the in-place constructor enhance the library's usability and maintainability.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #320 +/- ##
==========================================
- Coverage 87.50% 87.22% -0.28%
==========================================
Files 15 15
Lines 272 274 +2
==========================================
+ Hits 238 239 +1
- Misses 34 35 +1 ☔ View full report in Codecov by Sentry. |
Author
|
@ayushpatnaikgit can you please review? |
Member
|
Hi, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 closes issue #232
This commit introduces a significant refactor to the
SurveyDesignstruct in theSurveyDesign.jlfile. A new in-place constructor function,SurveyDesign!, has been added to allow for direct manipulation of the passedAbstractDataFrame. This change aims to enhance the flexibility and efficiency of survey design creation by providing an option to modify the data frame in place.Additionally, minor formatting adjustments were made to improve code readability and consistency across the file. These include alignment of default parameter values and minor adjustments to spacing and line breaks.
The introduction of the
SurveyDesign!function follows the Julia convention of using the!suffix to indicate functions that modify their arguments in place. This change is expected to make the API more intuitive for users familiar with Julia conventions.Overall, this refactor and the addition of the in-place constructor enhance the library's usability and maintainability.