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

Remove package manual file #36

Merged
merged 3 commits into from
Aug 29, 2023
Merged

Conversation

jsahrmann
Copy link
Contributor

Description

Remove unnecessary package manual file per CRAN's request.

Closes #35

Checklist

  • This PR does NOT contain Protected Health Information (PHI). A repo may need to be deleted if such data is uploaded.
    Disclosing PHI is a major problem1 - Even a small leak can be costly2.

  • This PR does NOT contain germline genetic data3, RNA-Seq, DNA methylation, microbiome or other molecular data4.

  • This PR does NOT contain other non-plain text files, such as: compressed files, images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other output 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.

  • Both R CMD build and R CMD check run successfully.

Footnotes

  1. UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records

  2. The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records.

  3. Genetic information is considered PHI.
    Forensic assays can identify patients with as few as 21 SNPs

  4. RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity.

NEWS Outdated
@@ -1,4 +1,4 @@
VennDiagram 1.8.0 2023-08-23 (Stefan Eng, Dan Knight)
VennDiagram 1.8.0 2023-08-28 (Stefan Eng, Dan Knight)
Copy link
Contributor

@dan-knight dan-knight Aug 29, 2023

Choose a reason for hiding this comment

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

Add yourself! Also, you can add yourself as a contributor in DESCRIPTION.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The package doesn't have an Authors@R field in DESCRIPTION where I could add myself, and apparently Maintainer can only be a single person: "The mandatory ‘Maintainer’ field should give a single name followed by a valid (RFC 2822) email address in angle brackets" (Writing R Extensions). I can add the Authors@R field or just stop with the addition to NEWS. I probably don't need to be considered a contributor after just deleting a file, so I'd be fine with just that.

@dan-knight dan-knight self-requested a review August 29, 2023 17:37
@jsahrmann jsahrmann merged commit 39c3959 into main Aug 29, 2023
2 checks passed
@jsahrmann jsahrmann deleted the jsahrmann-remove-package-manual-file branch August 29, 2023 18: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.

Unnecessary package manual file
2 participants