Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add print/plot S3 methods for VennDiagram #28

Merged
merged 10 commits into from
Aug 23, 2023
Merged

Conversation

stefaneng
Copy link
Contributor

@stefaneng stefaneng commented Feb 28, 2023

Description

Implement print/plot S3 methods for VennDiagram class.

Closes #26

Checklist

  • This PR does NOT contain PHI or germline genetic data. A repo may need to be deleted if such data is uploaded. Disclosing PHI is a major problem.
  • This PR does NOT contain molecular files, compressed files, output files such as images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other non-plain-text files. To automatically exclude such files using a .gitignore file, see here for example.
  • I have read the code review guidelines and the code review best practice on GitHub check-list.
  • I have set up or verified the main branch protection rule following the github standards before opening this pull request.
  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].
  • I have added the major changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

Example

No grid.draw call required.

library(VennDiagram)
VennDiagram::venn.diagram(list(A = 1:150, B = 121:170), filename = NULL)

NEWS Outdated
@@ -1,3 +1,8 @@
VennDiagram 1.7.4 2023-02-28 (Stefan Eng)
Copy link
Contributor

@dan-knight dan-knight Mar 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as previous version number.

DESCRIPTION Outdated
@@ -1,5 +1,5 @@
Package: VennDiagram
Version: 1.7.4
Version: 1.7.5
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be 1.8.0 as this is technically new functionality?

@dan-knight
Copy link
Contributor

Very cool quality of life improvement. Could we add some unit tests for the different cases in the S3 function?

@stefaneng
Copy link
Contributor Author

stefaneng commented Mar 22, 2023

Very cool quality of life improvement. Could we add some unit tests for the different cases in the S3 function?

I'm not quite sure how to test this. Any suggestions?

@dan-knight
Copy link
Contributor

I'm not quite sure how to test this. Any suggestions?

Given the current end-to-end test cases, do the changes you made here affect them as written? In other words, if this code was incorrect, would it make the existing test cases fail?

@stefaneng
Copy link
Contributor Author

I'm not quite sure how to test this. Any suggestions?

Given the current end-to-end test cases, do the changes you made here affect them as written? In other words, if this code was incorrect, would it make the existing test cases fail?

All the old tests still work. No, it would not make the tests fail since there old tests don't look at class at all and there is no print or plot method called at all.

@dan-knight
Copy link
Contributor

No, it would not make the tests fail since there old tests don't look at class at all and there is no print or plot method called at all.

Right. It might just be good to have some code that explicitly calls the S3 methods you defined here. Also, maybe a test case that asserts is('VennDiagram')?

@dan-knight dan-knight merged commit 509fd27 into main Aug 23, 2023
2 checks passed
@dan-knight dan-knight deleted the stefaneng-s3-print-26 branch August 23, 2023 20:07
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.

Implement print/plot S3 methods for VennDiagram
2 participants