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.

Sign up for GitHub

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
merged 11 commits into from
Dec 20, 2024
Merged

Add example table to analysis/README #947

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ae7e0a5
Add table to readme with example modules
sjspielman Dec 16, 2024
bb95a28
Merge branch 'main' into sjspielman/update-analysis-readme
sjspielman Dec 16, 2024
b087521
remove seurat conversion line from table
sjspielman Dec 20, 2024
649a109
Merge branch 'main' into sjspielman/update-analysis-readme
sjspielman Dec 20, 2024
0e94e63
Merge branch 'main' into sjspielman/update-analysis-readme
sjspielman Dec 20, 2024
bf190aa
make module names links
sjspielman Dec 20, 2024
43abc13
merge
sjspielman Dec 20, 2024
bccc2c3
try spacing
sjspielman Dec 20, 2024
17c91fc
revert 'try spacing'
sjspielman Dec 20, 2024
fa1c68d
Update analyses/README.md
sjspielman Dec 20, 2024
0436935
Merge branch 'main' into sjspielman/update-analysis-readme
jashapiro Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions analyses/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@ This directory contains the [OpenScPCA analysis modules](https://openscpca.readt

Each directory represents a single analysis module.
Each module contains a `README.md` file with information on its scientific goals and how to run it.

## Example modules

Several modules are provided as examples for how to use certain frameworks in OpenScPCA:

| 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?

| `hello-python` | Demonstrates an example structure of a Python-based module
| `hello-cluster` | Provides notebooks demonstrating the use of clustering and cluster evaluations functions in the [`rOpenScPCA` package](https://github.com/AlexsLemonade/rOpenScPCA/)
Loading