readability/flow of the pipeline documentation

[nishapuri]

Hi @daniellebraun and @mbsabath , I just wanted to follow up and let you both know I read through the HEI data reproducibility pipeline documents here! I made a few changes for clarity (I hope that is okay, nothing major just restructuring some sentences so it makes sense to an outsider such as myself).

Aside from that I feel that it was easy to follow and for the most part easy to read, especially in the health outcomes folder where you show the diagram. My only question is what is the flow for the final report? While I was reading these documents, it was a bit difficult to navigate the order for which folder and which document to read in order to understand the diagram towards the end. Perhaps a table of contents that explicitly outlines which steps were first (ex: first we prepared the confounders, beginning with BRFSS then followed by census and ending with google earth, etc.) would help the flow of going through these documents? Had I had this initially it would have made the documentation a bit more clear.

Thank you!

[daniellebraun]

Thanks, very helpful. Re:
" it was a bit difficult to navigate the order for which folder and which document to read in order to understand the diagram towards the end. Perhaps a table of contents that explicitly outlines which steps were first (ex: first we prepared the confounders, beginning with BRFSS then followed by census and ending with google earth, etc.) would help the flow of going through these documents?"
The overall readme file should have made this clear, @mbsabath maybe you can work on it a bit to clarify these points?
Thanks!!

[mbsabath]

Table of contents with links to each of the internal readmes added to the top level read me.

[daniellebraun]

Thanks! will look at it.