Add survival analysis README

[jharenza]

Purpose/implementation Section

What scientific question is your analysis addressing?

Adding a README to the survival analysis module

What was your approach?

Add README

What GitHub issue does your pull request address?

1249

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

Which areas should receive a particularly close look?

please make sure I captured everything!

Is there anything that you want to discuss further?

no

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

yes, but multiple of these module contents are in PR, so probably review once #1344, #1332, and #1342 are merged

Results

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

What is your summary of the results?

Reproducibility Checklist

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

Documentation Checklist

• [x] This analysis module has a README and it is up to date.
• [x] This analysis is recorded in the table in analyses/README.md and the entry is up to date.
• [x] The analytical code is documented and contains comments.

[jharenza]

We have so many files that are exported here that I think a table in the README is merited. Eg columns could be: filename, model_formula, input data description where the final column could be something like "full cohort" or "stranded-only", etc.

I agree there are SO many files. While updating the others - what do you think about adding additional folders per survival analysis notebook to organize them a bit more?

[sjspielman]

While updating the others - what do you think about adding additional folders per survival analysis notebook to organize them a bit more?

Yes! Absolutely!! Good call.

[sjspielman]

@jharenza all survival updated notebooks have been merged in 🥳 , so this is ready for another pass with the updated file structure. Let me know if you want me to take it over!

[jharenza]

@sjspielman I will update this next

[jharenza]

think this is ready for re-review @sjspielman

[sjspielman]

Looks good! Merging in now.