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

Cna vignette #265

Closed
wants to merge 8 commits into from
Closed

Cna vignette #265

wants to merge 8 commits into from

Conversation

alrein-05
Copy link
Collaborator

What changes are proposed in this pull request?
-Added basic definitions and information about copy number analysis including how to obtain the two forms of copy number data from cBioPortal, and a basic outline of creating a copy number heatmap using seg.means data

If there is an GitHub issue associated with this pull request, please provide link.


Reviewer Checklist (if item does not apply, mark is as complete)

  • 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.
  • If a new function was added, function included in _pkgdown.yml
  • If a bug was fixed, a unit test was added for the bug check
  • Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
  • 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.
  • R CMD Check runs without errors, warnings, and notes
  • usethis::use_spell_check() runs with no spelling errors in documentation

When the branch is ready to be merged into master:

  • 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).
  • Run codemetar::write_codemeta()
  • Run usethis::use_spell_check() again
  • Approve Pull Request
  • Merge the PR

hfuchs5 and others added 2 commits February 21, 2023 14:39
Added basic information on copy number analysis presented in Open Study Group
@karissawhiting
Copy link
Collaborator

@alrein-05 This looks really good! Thanks very much for adding :)

I think next steps include:

  • Adding an Introduction section explaining when/ why someone would want to analyze copy number data and stating the aim of the vignette (do you have a reference paper we can add with an example of a good CNA analysis? Doesn't have to be MSK). This could be combined with your current 'What are copy number alterations' section.
  • Expanding outline into more descriptive sections in the style of the other vignette: https://mskcc-epi-bio.github.io/gnomeR/articles/data-processing-vignette.html
  • Adding some code and an example working through seg data for users to follow along in the vignette. For now we can use the example seg file in the package: gnomeR::seg
  • Are there any additional types of analysis you do on this data after you create heatmaps? Hannah and I can share the workflow outline Caroline gave us and we can add from there as well.

Do you have time/interest to continue with these updates? We'd love your continued input but if not, no worries. @hfuchs5 and I can take over.

Thanks again for your great work!

@karissawhiting
Copy link
Collaborator

This PR was combined with PR #297

@karissawhiting karissawhiting deleted the cna_vignette branch October 6, 2023 19:45
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.

3 participants