More explicit separation between which are exported vs internal-only functions.
All internal functions start with a period (eg. .check_required_cols()) and are removed from NAMESPACE export list. If these are internal helpers for create_gene_binary(), they are in utils-gene-binary.R. Otherwise, they are in utils.R.
Other user-facing and exported helpers/utilities are in utils-exported-helpers.R.
I’ve removed the sanitize_mutations(), sanitize_cna(), sanitize_fusions() functions and instead replaced them with smaller, more modular and explicit functions that do all the same tasks. This helps test, debug and troubleshoot some of the more complicated processing pipelines and now we have nice explicit pipes like this:
If there is an GitHub issue associated with this pull request, please provide link.
328
Reviewer Checklist (if item does not apply, mark is as complete)
[x] PR branch has pulled the most recent updates from main branch. Ensure the pull request branch and your local version match and both have the latest updates from the main branch.
[x] If a new function was added, function included in _pkgdown.yml
[x] If a bug was fixed, a unit test was added for the bug check
[x] Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
[x] Code coverage is suitable for any new functions/features. Review coverage with withr::with_envvar(new = c("NOT_CRAN" = "true"), covr::report()). Begin in a fresh R session without any packages loaded.
[x] R CMD Check runs without errors, warnings, and notes
[x] usethis::use_spell_check() runs with no spelling errors in documentation
When the branch is ready to be merged into master:
[x] Update NEWS.md with the changes from this pull request under the heading "# cbioportalR (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (see NEWS.md for examples).
What changes are proposed in this pull request?
Here is a run down of the updates:
More explicit separation between which are exported vs internal-only functions.
All internal functions start with a period (eg.
.check_required_cols()
) and are removed from NAMESPACE export list. If these are internal helpers forcreate_gene_binary()
, they are inutils-gene-binary.R
. Otherwise, they are inutils.R
.Other user-facing and exported helpers/utilities are in
utils-exported-helpers.R
.I’ve removed the
sanitize_mutations()
,sanitize_cna()
,sanitize_fusions()
functions and instead replaced them with smaller, more modular and explicit functions that do all the same tasks. This helps test, debug and troubleshoot some of the more complicated processing pipelines and now we have nice explicit pipes like this:If there is an GitHub issue associated with this pull request, please provide link.
328
Reviewer Checklist (if item does not apply, mark is as complete)
_pkgdown.yml
pkgdown::build_site()
. Check the R console for errors, and review the rendered website.withr::with_envvar(new = c("NOT_CRAN" = "true"), covr::report())
. Begin in a fresh R session without any packages loaded.usethis::use_spell_check()
runs with no spelling errors in documentationWhen the branch is ready to be merged into master:
NEWS.md
with the changes from this pull request under the heading "# cbioportalR (development version)
". If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.md
for examples).codemetar::write_codemeta()
usethis::use_spell_check()
again