Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

some minor updates to aSHM code #26

Merged
merged 1 commit into from
Aug 13, 2021
Merged

some minor updates to aSHM code #26

merged 1 commit into from
Aug 13, 2021

Conversation

rdmorin
Copy link
Collaborator

@rdmorin rdmorin commented Aug 12, 2021

Pull Request Checklists

Important: When opening a pull request, keep only the applicable checklist and delete all other sections.

Checklist for all PRs

Required

  • I tested the new code for my use case (please provide a reproducible example of how you tested the new functionality)
get_mutation_frequency_bin_matrix(these_samples_metadata = some_meta,
                                  cluster_rows_heatmap = FALSE,
                                  regions_df = some_regions,
                                  customColour=col_list,
                                  min_bin_recurrence = 20,
                                  window_size = 500,
                                  slide_by = 500,
                                  orientation = "sample_rows", #change to "gene_rows" to rotate
                                  min_count_per_bin = 1,
                                  sortByColumns = c("pathology","genetic_subgroup","manta_MYC_sv","manta_MYC_partner"),
                                  metadataColumns=
                                    c("manta_MYC_sv","manta_MYC_partner","genetic_subgroup",
                                      "pathology"))
  • I ensured all dplyr functions that commonly conflict with other packages are fully qualified.

This can be checked and addressed by running check_functions.pl and responding to the prompts. Test your code after you do this.

  • I generated the documentation and checked for errors relating to the new function (e.g. devtools::document()) and added NAMESPACE and all other modified files in the root directory and under man.

Optional but preferred with PRs

  • I updated and/or successfully knitted a vignette that relies on the modified code (which ones?)

Checklist for New Functions

Required

  • I documented my function using ROxygen style.)

  • All parameters for the function are described in the documentation and the function has a decriptive title.

Example:

#' Use GISTIC2.0 scores output to reproduce maftools::chromoplot with more flexibility
#'
#' @param scores output file scores.gistic from the run of GISTIC2.0
#' @param genes_to_label optional. Provide a data frame of genes to label (if mutated). The first 3 columns must contain chromosome, start, and end coordinates. Another required column must contain gene names and be named `gene`. (truncated for example)
#' @param cutoff optional. Used to determine which regions to color as aberrant. Must be float in the range [0-1]. (truncated for example)
  • My function uses a library that isn't already a dependency of GAMBLR and I made the package aware of this dependency using the function documentation import statment.

Example:

#' @return nothing
#' @export
#' @import tidyverse ggrepel

Checklist for changes to existing code

  • I added/removed arguments to a function and updated documentation for all changed/new arguments

  • I tested the new code for compatability with existing functionality in the Master branch (please provide a reprex of how you tested the original functionality)

all_meta = all_meta %>% dplyr::filter(cohort %in% c("BL_Adult","BL_cell_lines","BL_ICGC","BLGSP_Bcell_UNC","BL_Pediatric") |(cohort=="LLMPP_P01" & pathology == "BL"))
all_meta = all_meta %>%
dplyr::filter(cohort %in% c("BL_Adult","BL_cell_lines","BL_ICGC","BLGSP_Bcell_UNC","BL_Pediatric") |
(cohort=="LLMPP_P01" & pathology == "BL"))
Copy link
Collaborator

Choose a reason for hiding this comment

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

This probably needs an update to be pathology == "HGBL" since this came back from path review

@Kdreval Kdreval merged commit a527422 into master Aug 13, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants