-
Notifications
You must be signed in to change notification settings - Fork 1
feat: cohort building release 1 #188
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b920e6b
feat: cohort building release 1
mkirk111 69a16e2
revise: release notes
mkirk111 84637f5
Fix formatting of off-plot samples description
mkirk111 873b428
revise: copilot review changes
mkirk111 cfaa40d
revise: review comments
mkirk111 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| title: Cohort Building | ||
| navigation: | ||
| title: Create Custom Cohorts | ||
| --- | ||
| Cohort features in PeCan allow users to dynamically build and stratify cohorts of samples, then explore their data across OncoPrint, Histology, and Expression. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| To begin creating and exploring cohorts, start by logging in to PeCan. | ||
| If you don't have a St. Jude Cloud account, you can find the account creation steps in our documentation. [Creating a St. Jude Cloud Account](https://docs.stjude.cloud/genomics-platform/getting-started/accounts-and-billing#creating-a-st-jude-cloud-account) | ||
|
|
||
| ### Creating a new cohort | ||
|
|
||
| Once you are logged in, you can start creating your own custom cohorts through the Subtype Search, Subtype Tree, the Cohorts page, or from one of the following areas of PeCan: OncoPrint, Histology, or Expression. | ||
|
|
||
| Select your samples of interest, then select "Add to Cohort." | ||
| The "Add to Cohort" button is available in several locations throughout the app. | ||
| If you would like to explore all samples in PeCan, use the Cohorts page to view all samples. | ||
| You can easily apply filters and create cohorts from this view as well. | ||
| After selecting "Add to Cohort," you'll be prompted to add a cohort name and an optional description. | ||
|
|
||
| > **Note:** You can also add samples to an existing cohort at this step by selecting an existing cohort from the modal. | ||
| >Review your samples in the confirmation modal, and deselect any samples you'd like to exclude before submitting. | ||
|
|
||
|  | ||
|
|
||
| **Figure 1: Creating a Cohort from Subtype Tree.** | ||
| Selecting a group of samples from the subtype tree is an easy way to create a cohort containing all samples of a particular subtype. | ||
|
|
||
| ## Viewing a Cohort | ||
|
|
||
| ### Lens | ||
|
|
||
| To view or compare cohorts in PeCan's data facets, use the Cohort Lens to make your selection. | ||
| The primary lens defaults to All PeCan Samples; select from the lens menu to view one of your custom cohorts instead. | ||
| To compare against another cohort's samples, select the Compare option and choose your secondary lens cohort. | ||
|
|
||
|  | ||
|
|
||
| **Figure 2: Cohort Lens.** | ||
| Select a cohort from the lens menu to view the cohort's samples in cohort supported data facets. | ||
|
|
||
| ### Cohort Summary Page | ||
|
|
||
| To view all your cohorts and their associated metadata in one place, navigate to the Cohort page using the left-side navigation. | ||
| From there, select one of your existing cohorts to review its samples and their associated metadata. | ||
|
|
||
| From the Cohort page, you can also create new cohorts from the All Samples dataset or edit your custom cohorts by filtering to remove samples or by copying samples into another cohort. | ||
|
|
||
|  | ||
| **Figure 3: Cohort Summary Page** | ||
| The cohort summary page provides an easy way for you to view all of your cohorts and their associated data in one place. You can add and remove samples, update a cohort's name and description, and export cohort data from this view. | ||
|
|
||
| --- | ||
|
|
||
| ## Cohort Views in PeCan's Data Facets | ||
|
|
||
| To view and compare your cohorts, make your selections in the lens, then navigate to OncoPrint (Variants > OncoPrint), Expression, or Histology to view the samples in the selected cohort(s). | ||
|
|
||
| ### OncoPrint | ||
|
|
||
| View an OncoPrint visualization scoped to the samples in your custom cohort. | ||
| Select another cohort in the lens to compare mutations across the two sets of samples. | ||
|
|
||
| :callout[**Note:** Set the filter to the root type you'd like to view in order to render the plot.]{icon="i-heroicons-document-text-solid" color="blue"} | ||
|
|
||
| ### Expression | ||
|
|
||
| Explore gene expression across custom cohorts using the t-SNE or Gene Expression plots. | ||
|
|
||
| **t-SNE** Select the cohort(s) you'd like to view. | ||
| The t-SNE will scope to your cohorts' samples and differentiate them by shape; any sample belonging to both cohorts is represented as a diamond. | ||
| Select the "Color by Cohort" toggle to adjust the view. | ||
| The header shows the number of samples in view, and the number of samples off-plot — update the subtype root filter or select the quick link in the header to bring off-plot samples into view. | ||
|
|
||
|  | ||
| **Figure 5: Comparing two cohorts in PeCan's Expression tSNE** | ||
|
|
||
| **Gene Expression** Select the cohort(s) you'd like to view and one or more genes. | ||
| The violin plots will scope to your cohorts' samples. | ||
| To see more granular plots by subtype, select the subtypes of interest in the subtype filter. | ||
| Toggle data points on or off to view individual sample values and metadata. | ||
|
|
||
|  | ||
| **Figure 6: Comparing two cohorts in Gene Expression** | ||
|
|
||
| ### Histology | ||
|
|
||
| Select the cohort(s) you'd like to view. | ||
| The slide gallery will update to show samples within your cohorts. | ||
| A cohort badge icon displays on each slide thumbnail to indicate which cohort it belongs to. | ||
|
|
||
|  | ||
| **Figure 7: Histology Cohort View** | ||
|
|
||
| --- | ||
|
|
||
| Don't see your cohort samples? | ||
| Try clearing the page filters from the left-side filter panel, this resolves the issue in most cases. | ||
|
|
||
| --- | ||
|
|
||
| This is the first release of a broader set of cohort-building features on St. Jude Cloud. | ||
| We plan to continue expanding cohort support across the application, including St. Jude Cloud curated cohorts, cohort views in Variant Prevalence and Mutational Signatures, and more. | ||
|
|
||
| Please share any feedback or questions with <support@stjude.cloud>. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| title: Cohort Building |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.