Skip to content
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

Merged

Conversation

sjspielman
Copy link
Member

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!

@sjspielman sjspielman requested review from jashapiro and removed request for jaclyn-taroni December 16, 2024 15:40
@sjspielman
Copy link
Member Author

Might need to rethink this, since the seurat-conversion module is actually doing conversions, not necessarily demonstrating usage, which indeed we may not need to demonstrate now that we're planning on providing objects(?).

@jashapiro
Copy link
Member

Might need to rethink this, since the seurat-conversion module is actually doing conversions, not necessarily demonstrating usage, which indeed we may not need to demonstrate now that we're planning on providing objects(?).

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.

@sjspielman
Copy link
Member Author

I think this README is still helpful, so I'll just rip out that line in the table.


| Module name | Purpose
|-------------|---------
| `hello-R` | Demonstrates an example structure of an R-based module
Copy link
Member

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?

@sjspielman sjspielman requested a review from jashapiro December 20, 2024 16:05
Copy link
Member

@jashapiro jashapiro left a 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.

analyses/README.md Outdated Show resolved Hide resolved
@sjspielman
Copy link
Member Author

sjspielman commented Dec 20, 2024

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!

sjspielman and others added 2 commits December 20, 2024 11:20
@sjspielman sjspielman merged commit a446aa2 into AlexsLemonade:main Dec 20, 2024
2 checks passed
@sjspielman sjspielman deleted the sjspielman/update-analysis-readme branch December 20, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants