morinlab / GAMBLR

Set of standardized functions to operate with genomic data
https://morinlab.github.io/GAMBLR/
MIT License
3 stars 2 forks source link

Bundled data descriptions, argument descriptions, and portal.R stuff #176

Closed mattssca closed 1 year ago

mattssca commented 1 year ago

This PR addresses the following issues:

  1. https://github.com/morinlab/GAMBLR/issues/172
  2. https://github.com/morinlab/GAMBLR/issues/173

In addition, this PR also includes some new functions to the portal.R scripts. New functions related to configuring and setting up existing cBioPortal studies.

Pull Request Checklists

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

Checklist for all PRs

Required

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

Optional but preferred with PRs

Checklist for New Functions

Required

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)

Example:

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

Checklist for changes to existing code

Kdreval commented 1 year ago

Thanks Adam!