Clarification of the meaning of "results" in code and plots #91 issue

[aleksandraduda2]

Summary by CodeRabbit

• Refactor
  • Simplified smd_covariants_data by removing the strata parameter and updating the returned output and SMD field names. Existing code may need to align with the new argument list and column names.
• Documentation
  • Updated the minimization vs randomization vignette with standardized terminology (randomization) and clearer wording throughout to improve readability and consistency.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.84%. Comparing base (f570d20) to head (bb8ac59).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #97   +/-   ##
=======================================
  Coverage   99.84%   99.84%           
=======================================
  Files          11       11           
  Lines         657      657           
=======================================
  Hits          656      656           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Walkthrough

Updates the vignette to align with a revised smd_covariants_data signature (removes strata), renames SMD output fields (results_smd → smd_value; result_table → smd_result_table), and adjusts downstream references and wording (standardized “randomization” spelling).

Changes

Cohort / File(s)	Summary
Vignette update for SMD API change vignettes/articles/minimization_randomization_comparison.Rmd	Reflects new function signature smd_covariants_data(data, vars) (removes strata), updates references to output columns (smd_value, smd_result_table), and standardizes terminology/spelling; downstream selection/mutation adjusted accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit taps its paws in cheer,
“SMDs renamed—so crystal clear!”
One less strata in the call,
Tables tidy, columns small.
I hop through docs with nimble might—
Randomization spelled just right.
Carrots committed. Merge tonight! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The current title implies a generic clarification of "results" in code and plots but does not clearly capture the core refactoring of the smd_covariants_data function signature and renaming of output tables and variables. It also includes the issue number and uses broad phrasing that makes the main change unclear. As a result, a teammate scanning the history would not immediately grasp that the pull request updates the SMD function signature and renames result_table.	Please revise the title to concisely describe the primary change, for example "Refactor smd_covariants_data signature and rename result_table to smd_result_table, clarifying smd_value usage" and omit the issue reference.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 91-vignette-results

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f570d20 and bb8ac59.

📒 Files selected for processing (1)

• vignettes/articles/minimization_randomization_comparison.Rmd (9 hunks)

🔇 Additional comments (4)

vignettes/articles/minimization_randomization_comparison.Rmd (4)

27-27: LGTM: Spelling standardization improves consistency.

The change from "randomisation" (British English) to "randomization" (American English) throughout the document improves consistency.

Also applies to: 55-55, 373-373, 375-375, 379-379, 382-382, 643-643, 645-645

---

511-511: LGTM: Variable renaming improves code clarity.

The renaming of variables makes the code more descriptive and self-documenting:

• result_table → smd_result_table
• results → smd_table
• Column renamed to smd_value for clarity
• success_data → success_table
• Success metric renamed to power

All references have been updated consistently throughout the pipeline.

Also applies to: 528-529, 531-531, 537-537, 543-543, 570-570, 572-572, 574-574, 611-611, 617-617, 623-623, 625-625, 635-635

---

577-578: LGTM: Plot labeling improvements enhance clarity.

The updates to plot labels and themes improve the visual presentation:

• More descriptive y-axis labels explicitly referencing "SMD value"
• Consistent theme application with theme_bw()
• Improved axis text readability

Also applies to: 586-586, 595-596

---

510-510: Approve signature update Verified that smd_covariants_data is only invoked with two parameters (vignettes/articles/minimization_randomization_comparison.Rmd:549); no callers pass a third strata argument.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[kamilsi]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.