AlexsLemonade / OpenPBTA-analysis

The analysis repository for the Open Pediatric Brain Tumor Atlas Project
Other
99 stars 66 forks source link

Docs updates - data files and analysis README #1451

Closed jharenza closed 2 years ago

jharenza commented 2 years ago

Purpose/implementation Section

What scientific question is your analysis addressing?

Adding missing documentation to analysis README and data-files-description.md

What was your approach?

Added requested information to the documentation

What GitHub issue does your pull request address?

Closes #1431 Closes #1427 Closes #1428

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

Which areas should receive a particularly close look?

Please check to make sure I did not miss anything

Is there anything that you want to discuss further?

For #1431 , did you want the file names listed in this column as well? UPDATE - I see these in another column, and updated a few files here. For the markdown table updates, I had used a web tool for updates, so some of the spacing came back as if there are more changes than previously, but this was the quickest way to do it I have found.

Is the analysis in a mature enough form that the resulting figure(s) and/or table(s) are ready for review?

yes

Results

What types of results are included (e.g., table, figure)?

updated docs

What is your summary of the results?

NA

Reproducibility Checklist

Documentation Checklist

jharenza commented 2 years ago

@sjspielman I think this is ready for re-review. I applied your changes and updated the BED file origins - if it was a reference file we received, linked to cavatica and if we generated, added the workflow link.