Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Update Documentation to Reflect SNV refactoring #304

Merged
merged 16 commits into from
Dec 3, 2019

Conversation

cansavvy
Copy link
Collaborator

@cansavvy cansavvy commented Dec 2, 2019

Purpose/implementation Section

Main changes

  • Revamped the whole README to reflect the refactoring of the SNV scripts.
  • Got rid of the 00-setup.R and its being called in the bash script.

What GitHub issue does your pull request address?

#296

Directions for reviewers. Tell potential reviewers what kind of feedback you are soliciting.

Which areas should receive a particularly close look?

  • Does this make the analysis and it methods more clear?
  • Would you feel confident in re-running this analysis by looking at this documentation?
  • Is there anything in particular that is missing and should be documented more?
  • Is there anywhere that should have a link to a source some place that doesn't currently have a link?

Results

No new results just updating the documentation

Reproducibility Checklist

These items were taken care of previously.

  • The dependencies required to run the code in this pull request have been added to the project Dockerfile.
  • This analysis has been added to continuous integration.

@cansavvy cansavvy changed the title Update snv readme Update Documentation to Reflect SNV refactoring Dec 2, 2019
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

Looks pretty good! There are few places where I think more detail would be good, and a bit of repetitiveness that could be cleaned up, I think.

analyses/snv-callers/README.md Outdated Show resolved Hide resolved
analyses/snv-callers/README.md Outdated Show resolved Hide resolved
analyses/snv-callers/README.md Outdated Show resolved Hide resolved
analyses/snv-callers/README.md Outdated Show resolved Hide resolved
analyses/snv-callers/README.md Outdated Show resolved Hide resolved
analyses/snv-callers/README.md Outdated Show resolved Hide resolved
Co-Authored-By: jashapiro <jashapiro@gmail.com>
Copy link
Member

@jashapiro jashapiro left a comment

Choose a reason for hiding this comment

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

Looks good.

@jaclyn-taroni jaclyn-taroni merged commit 4259e3f into AlexsLemonade:master Dec 3, 2019
@cansavvy cansavvy deleted the update-snv-README branch December 19, 2019 13:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants