-
Notifications
You must be signed in to change notification settings - Fork 18
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
Add example table to analysis/README #947
Add example table to analysis/README #947
Conversation
Might need to rethink this, since the |
Yeah, I don't have plans to create notebooks for Seurat conversion. It might be nice to have some demonstrations if people want to work with some of the options, but I actually think this may be better provided in the docs. |
I think this README is still helpful, so I'll just rip out that line in the table. |
analyses/README.md
Outdated
|
||
| Module name | Purpose | ||
|-------------|--------- | ||
| `hello-R` | Demonstrates an example structure of an R-based module |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is displayed on the page, do we want the names to be links to the modules themselves?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, with typo fix.
But now I'm a bit worried the links might not work as they are. I don't think a full url is worth doing, but I guess we can test after merge.
Already tested in my fork :) https://github.com/sjspielman/OpenScPCA-analysis/tree/sjspielman/update-analysis-readme/analyses edit - except clearly i didn't test the last line 😬 . it works now! |
Co-authored-by: Joshua Shapiro <josh.shapiro@ccdatalab.org>
Inspired by the brief conversation in #945 about naming, I took a stab at expanding
analysis/README.md
with a table indicating which modules are provided as examples of some flavor, rather than bona fide scientific analyses.Let me know what you think!