First off, thank you for creating and maintaining the ggvenn package! It's a valuable tool for creating Venn diagrams in R.
This pull request focuses on two key improvements, laying the groundwork for the integration of exciting new features I've been developing:
1. Improved documentation:
The documentation for the ggvenn function has been updated to include the missing comma_sep argument. This resolves the warning message encountered during R CMD check:
❯ checking for code/documentation mismatches ... WARNING
Codoc mismatches from documentation object 'ggvenn':
...
Argument names in code not in docs:
- comma_sep
2. Added tests - Crucial for upcoming feature integration:
I've been actively working on some new features for ggvenn that I believe will significantly enhance its capabilities. To ensure a smooth and reliable integration of these features, a comprehensive test suite has been added. This is crucial to prevent regressions and ensure that the existing functionality remains intact as new features are introduced. The tests cover examples from the current documentation and include additional test cases for robustness.
Specific changes:
Documentation: The ggvenn.Rd file has been updated to include documentation for the comma_sep parameter.
Tests: A new tests/testthat.R file has been added with tests covering various aspects of the ggvenn functionality.
Version bump: The package version has been incremented to 0.1.12 to reflect these changes.
These improvements, particularly the addition of tests, are vital for the future of ggvenn. They provide a safety net for introducing new features without compromising the stability and reliability of the existing codebase. I'm excited to share these new features in upcoming pull requests!
First off, thank you for creating and maintaining the
ggvennpackage! It's a valuable tool for creating Venn diagrams in R.This pull request focuses on two key improvements, laying the groundwork for the integration of exciting new features I've been developing:
1. Improved documentation:
ggvennfunction has been updated to include the missingcomma_separgument. This resolves the warning message encountered duringR CMD check:2. Added tests - Crucial for upcoming feature integration:
ggvennthat I believe will significantly enhance its capabilities. To ensure a smooth and reliable integration of these features, a comprehensive test suite has been added. This is crucial to prevent regressions and ensure that the existing functionality remains intact as new features are introduced. The tests cover examples from the current documentation and include additional test cases for robustness.Specific changes:
ggvenn.Rdfile has been updated to include documentation for thecomma_sepparameter.tests/testthat.Rfile has been added with tests covering various aspects of theggvennfunctionality.These improvements, particularly the addition of tests, are vital for the future of
ggvenn. They provide a safety net for introducing new features without compromising the stability and reliability of the existing codebase. I'm excited to share these new features in upcoming pull requests!Thank you for considering this contribution!