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

🧹 v1.0 release prep #19

Merged
merged 4 commits into from
Jun 13, 2024
Merged

🧹 v1.0 release prep #19

merged 4 commits into from
Jun 13, 2024

Conversation

dmiller15
Copy link
Contributor

@dmiller15 dmiller15 commented Jun 11, 2024

Description

Prepare the tumor only workflow for release v1.0.0

Change log:

  • Update main README to include link to and summary of run recommendations
  • Add tool_name outputs to Manta and ControlFREEC to enable more control in output naming
  • Update Mutect2 bam sort-index step to include tool_name in output name
  • Cleaned up Manta tool; old tool was unreadable/overly complex
  • Updated public app formatting for tumor only workflow
  • Fixed typos
  • Bumped tumor only workflow version in anticipation of release

Part of https://d3b.atlassian.net/browse/BIXU-3679

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test Configuration:

  • Environment:
  • Test files:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have committed any related changes to the PR

@dmiller15 dmiller15 added documentation Regarding developer or user documentation bix-dev labels Jun 11, 2024
@dmiller15 dmiller15 self-assigned this Jun 11, 2024
@dmiller15 dmiller15 marked this pull request as ready for review June 12, 2024 19:15
Copy link
Collaborator

@migbro migbro 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!

return "--tumorBam " + inputs.input_tumor_aligned.path + " --normalBam " + inputs.input_normal_aligned.path + std + mv_cmd;
}
}
/manta-1.4.0.centos6_x86_64/bin/configManta.py --runDir=./
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some nice reorg and cleanup

$(inputs.input_normal_aligned != null ? inputs.input_tumor_aligned != null ? "--normalBam " + inputs.input_normal_aligned.path : "--bam " + inputs.input_normal_aligned.path : "")
- position: 10
shellQuote: false
prefix: "&&"
Copy link
Collaborator

Choose a reason for hiding this comment

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

prefix: "$$"?! Cue Joe Rogan freaking out GIF

@dmiller15 dmiller15 merged commit 12a9517 into main Jun 13, 2024
1 check passed
@dmiller15 dmiller15 deleted the dm-release-prep branch June 13, 2024 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bix-dev documentation Regarding developer or user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants