You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What is the documentation improvement or update you wish to see?
Currently, I don't think we have centralized docs where OpenScPCA contributors (and others!) can learn about the available results. We have documentation that results are available and how to obtain that, but the specific information about which modules have available results and what their contents are are quite spread out.
I am therefore opening this issue to suggest we add some information about available results. I think this could be a good way to go about it:
Add a table to the analyses/README.md file listing mature modules which have available results. This table can link to the module itself as well as the OpenScPCA-nf module. Might be helpful to also link to any Discussion that introduced those results when they were first released.
On the website in both the download-results.py sections and the OpenScPCA-nf sections, add statements that the repo's analyses/README.md file has a table of available results
Is there any additional context you would like to provide?
N/A
If this request is for an existing documentation page, please provide the link here.
Existing docs pages where we should say you can find available results in the README:
What is the documentation improvement or update you wish to see?
Currently, I don't think we have centralized docs where OpenScPCA contributors (and others!) can learn about the available results. We have documentation that results are available and how to obtain that, but the specific information about which modules have available results and what their contents are are quite spread out.
I am therefore opening this issue to suggest we add some information about available results. I think this could be a good way to go about it:
analyses/README.md
file listing mature modules which have available results. This table can link to the module itself as well as theOpenScPCA-nf
module. Might be helpful to also link to any Discussion that introduced those results when they were first released.download-results.py
sections and theOpenScPCA-nf
sections, add statements that the repo'sanalyses/README.md
file has a table of available resultsIs there any additional context you would like to provide?
N/A
If this request is for an existing documentation page, please provide the link here.
Existing docs pages where we should say you can find available results in the README:
The text was updated successfully, but these errors were encountered: