🏁 Initialize Project

migbro commented 2 years ago

Description

This is the first PR to initialize the project and create a beta release

Fixes # (issue)

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a 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

[ ] Successful KF workflow runs here
[ ] Successful Jax workflow runs here

Test Configuration:

Environment:
Test files:

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[x] 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
[x] I have checked my code and corrected any misspellings
[x] I have committed any related changes to the PR

afarrel commented 2 years ago

Hi @migbro, Thank you for putting this together. It's look great so far. One minor suggestion. Is it possible to include a high level description of each workflow (for someone who isn't in the weeds or too technical, ie input, outputs, purpose of the workflow/sub-workflows [cwl files]). If SBG has this already we can, just copy the descriptions into the readme file? These can either be in one readme file or have a descriptive line in each cwl file (your call - no preference). Please let me know your thoughts and if you agree. cc @chinwallaa

migbro commented 2 years ago

Hi @migbro, Thank you for putting this together. It's look great so far. One minor suggestion. Is it possible to include a high level description of each workflow (for someone who isn't in the weeds or too technical, ie input, outputs, purpose of the workflow/sub-workflows [cwl files]). If SBG has this already we can, just copy the descriptions into the readme file? These can either be in one readme file or have a descriptive line in each cwl file (your call - no preference). Please let me know your thoughts and if you agree. cc @chinwallaa

Sure - most of the workflows have the descriptions built into them. I will be more explicit that when one clicks on the link, it will take you to the workflow where inputs and outputs are already described

migbro commented 2 years ago

@afarrel @chinwallaa , ok I have added some readmes in the docs folder, and linked them in the main readme, as well as added some overviews

afarrel commented 2 years ago

Yep, the readmes look pretty comprehensive. Thanks!

migbro commented 2 years ago

Yep, the readmes look pretty comprehensive. Thanks!

Thanks @afarrel @chinwallaa - so, to make actually approval "official" so that the option to merge the pull request turns green, you need to actually click on the green review button, then in the top right, choose the radio button to approve.

d3b-center / d3b-ot-pdx-tumor-only-processing