Skip to content

Add dedicated vignettes for conditional correlations and contrast patterns - #51

Merged
beerda merged 7 commits into
mainfrom
copilot/create-new-vignettes-conditional-correlations-cont
Aug 8, 2026
Merged

Add dedicated vignettes for conditional correlations and contrast patterns#51
beerda merged 7 commits into
mainfrom
copilot/create-new-vignettes-conditional-correlations-cont

Conversation

Copilot AI commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

This adds dedicated documentation for two pattern families that were previously covered only inside the general nuggets vignette. It also updates vignette navigation so the new material is discoverable from pkgdown, the README, the site index, and related articles.

  • New vignettes

    • Added vignettes/conditional-correlations.Rmd focused on dig_correlations()
    • Added vignettes/contrast-patterns.Rmd covering:
      • dig_baseline_contrasts()
      • dig_complement_contrasts()
      • dig_paired_baseline_contrasts()
  • Content structure

    • Split the overview material from vignettes/nuggets.Rmd into dedicated, task-oriented articles
    • Expanded the contrast-patterns material beyond the overview section with:
      • a reusable example dataset
      • parameter-oriented sections
      • examples for baseline, complement, and paired contrasts
      • links to related vignettes and function families
    • Built the conditional-correlations vignette from the existing overview plus R/dig_correlations.R documentation
  • Navigation and discoverability

    • Added both vignettes to _pkgdown.yml
    • Added a vignette index section to both README.Rmd and index.Rmd
    • Added cross-links from existing vignettes where the new articles are natural follow-ons
    • Added direct links from the main nuggets vignette to the new detailed articles
  • Example

    corr_basic <- dig_correlations(
        iris_corr,
        condition = where(is.logical),
        xvars = c(Sepal.Length, Sepal.Width, sepal_ratio),
        yvars = c(Petal.Length, Petal.Width, petal_ratio),
        min_length = 1,
        max_length = 1,
        min_support = 0.2
    )

Co-authored-by: beerda <26056018+beerda@users.noreply.github.com>
Co-authored-by: beerda <26056018+beerda@users.noreply.github.com>
Co-authored-by: beerda <26056018+beerda@users.noreply.github.com>
@beerda
beerda marked this pull request as ready for review August 8, 2026 05:58
@codecov

codecov Bot commented Aug 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.90%. Comparing base (bf18cc5) to head (dc750f2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #51   +/-   ##
=======================================
  Coverage   86.90%   86.90%           
=======================================
  Files         122      122           
  Lines        6392     6392           
=======================================
  Hits         5555     5555           
  Misses        837      837           

☔ View full report in Codecov by Harness.
📢 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.

@beerda
beerda merged commit ac8d130 into main Aug 8, 2026
8 checks passed
@beerda
beerda deleted the copilot/create-new-vignettes-conditional-correlations-cont branch August 8, 2026 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants