Skip to content

Docs request: Centralized documentation for available results #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sjspielman opened this issue May 6, 2025 · 0 comments
Open

Docs request: Centralized documentation for available results #1119

sjspielman opened this issue May 6, 2025 · 0 comments
Labels
OpenScPCA admin Issue for an OpenScPCA maintainer

Comments

@sjspielman
Copy link
Member

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:

@sjspielman sjspielman assigned sjspielman and unassigned sjspielman May 6, 2025
@sjspielman sjspielman added the OpenScPCA admin Issue for an OpenScPCA maintainer label May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OpenScPCA admin Issue for an OpenScPCA maintainer
Projects
None yet
Development

No branches or pull requests

1 participant