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

Standardize package repo #14

Merged
merged 10 commits into from
Jan 25, 2024
Merged

Standardize package repo #14

merged 10 commits into from
Jan 25, 2024

Conversation

forbiddenpersimmon
Copy link
Contributor

@forbiddenpersimmon forbiddenpersimmon commented Nov 6, 2023

Description

Updates made to update package as part of ShipIt-Day:

  • Add LICENSE.md to repo
  • Update files to ignore to include LICENSE and README
  • Add Issues link and GitHub repo to DESCRIPTION
  • Update NEWS with changes

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.

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.

@dan-knight
Copy link
Contributor

Is this ready to go? I think the extra discoverability from the links in DESCRIPTION will be beneficial.

@forbiddenpersimmon forbiddenpersimmon marked this pull request as ready for review January 24, 2024 00:03
@dan-knight
Copy link
Contributor

Approved! I just updated the date to reflect us revisiting this and merging.

@dan-knight dan-knight merged commit 4c798ce into main Jan 25, 2024
2 checks passed
@dan-knight dan-knight deleted the rdang-standardize-package branch January 25, 2024 01:03
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