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 badge for README #60

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Add badge for README #60

merged 1 commit into from
Jan 17, 2024

Conversation

yashpatel6
Copy link
Contributor

Description

Adding a basic badge to the README

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.

Copy link
Member

@zhuchcn zhuchcn left a comment

Choose a reason for hiding this comment

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

Cool!

We might get too much stuff in our README. At some poitn we should consider getting a gh-pages hosted static documentation site and transfer most of the things over there, leaving a simplistic README page.

@yashpatel6
Copy link
Contributor Author

Cool!

We might get too much stuff in our README. At some poitn we should consider getting a gh-pages hosted static documentation site and transfer most of the things over there, leaving a simplistic README page.

Agreed, we should switch to more extensive documentation to a different format than just a README

@yashpatel6 yashpatel6 merged commit bfc128e into main Jan 17, 2024
2 checks passed
@yashpatel6 yashpatel6 deleted the yashpatel-add-badge branch January 17, 2024 00:26
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