Docs request: Organizing your module results

[sjspielman]

What is the documentation improvement or update you wish to see?

We should add recommendations about how contributors might consider structuring their results output. The reason for this is because of how we anticipate to port modules over to OpenScPCA-nf, and associated use of the download-results.py script which has the ability to take projects and samples arguments. This would likely be a new doc added somewhere in the analysis modules section.

In parallel to explaining this results file structure, we should document the projects and samples arguments in the results download script. This should be added directly to those existing docs (forthcoming in #428, but will exist once we're ready to tackle this issue).

Is there any additional context you would like to provide?

-

If this request is for an existing documentation page, please provide the link here.

-

[sjspielman]

One thought: We could alternatively structure this page as "Organizing your module files":

• We'd first point back to the analysis module skeleton structure and creation script
• Explain run files (accomplishes part of my idea with #475)
• Explain structuring results files
• We might suggest things like exploratory-analyses or template-notebooks as example additional folders (e.g. see doublet and ewings cell type modules) they might choose to use for organization?