The READMEs for our packages tends to be more relevant to GitHub than to CRAN. Especially since we maintain vignette guides, it seems logical to exclude the README from the package build. This is consistent with BPG and Venn, which don't even have READMEs.
Checklist
[x] 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.
[x] 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.
[x] I have set up or verified the main branch protection rule following the github standards before opening this pull request.
[x] 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].
[x] 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.
Description
The READMEs for our packages tends to be more relevant to GitHub than to CRAN. Especially since we maintain vignette guides, it seems logical to exclude the README from the package build. This is consistent with BPG and Venn, which don't even have READMEs.
Checklist
.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.main
branch protection rule following the github standards before opening this pull request.CHANGELOG.md
under the next release version or unreleased, and updated the date.