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

feat: add new onboarding tours #200

Merged
merged 49 commits into from
Apr 18, 2023
Merged
Changes from 1 commit
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
384e09f
add data-testid
dvflorianengertsberger Nov 30, 2021
e464ad3
add id for dataset searchbox
dvvanessastoiber Dec 13, 2021
5879b89
add data-testid to react select components
dvflorianengertsberger Jan 4, 2022
5a31382
Merge remote-tracking branch 'origin/develop' into cypress-testing
dvvanessastoiber Jan 17, 2022
452b83e
fix lint
dvvanessastoiber Jan 17, 2022
d81f7a9
fix react select error
dvflorianengertsberger Jan 18, 2022
5a28b07
Merge remote-tracking branch 'origin/develop' into cypress-testing
dvvanessastoiber Mar 22, 2022
761c42f
update dist
dvvanessastoiber Mar 22, 2022
d22cb38
Merge remote-tracking branch 'origin/develop' into cypress-testing
dvvanessastoiber May 30, 2022
caec0d4
update dist
dvvanessastoiber May 30, 2022
e71f24e
rename for constistency
dvvanessastoiber Jun 7, 2022
617bc8c
Merge remote-tracking branch 'origin/develop' into cypress-testing
dvvanessastoiber Jun 21, 2022
3946d4e
update dist
dvvanessastoiber Jun 21, 2022
b944ee0
Merge remote-tracking branch 'origin/develop' into cypress-testing
dvvanessastoiber Jun 30, 2022
ee11bbc
Fix typings
thinkh Jun 30, 2022
fbc855a
add index.js
dvvanessastoiber Jul 19, 2022
2867237
fix setup
dvvanessastoiber Jul 19, 2022
e0d7459
update imports and function calls
dvvanessastoiber Jul 20, 2022
2fd228f
update video
dvvanessastoiber Jul 22, 2022
1e07eb1
Refactored cy related files for Cypress v10
dvmichaelpeterseil Aug 9, 2022
992a58d
Test Duplicant Tour
dvmichaelpeterseil Aug 16, 2022
de915c9
Halfway with AssessBCCellLines tour
dvmichaelpeterseil Aug 22, 2022
1443bda
Almost done AssessBCCellLines tour
dvmichaelpeterseil Aug 22, 2022
3f9ca9f
Merge remote-tracking branch 'origin/develop' into sorry_cypress_testing
dvmichaelpeterseil Aug 22, 2022
ff6fb0e
Merge remote-tracking branch 'origin/sorry_cypress_testing' into dvMi…
dvmichaelpeterseil Aug 22, 2022
f23554c
Update Dist
dvmichaelpeterseil Aug 22, 2022
5eab43a
Fixed Hidden Modal Bug
dvmichaelpeterseil Aug 29, 2022
f52de57
AssessBCCellLines Tour Complete (Unpolished)
dvmichaelpeterseil Aug 30, 2022
38fbf9e
AssessBCCellLine Tour Complete (Polished)
dvmichaelpeterseil Sep 2, 2022
cbfdd78
Prep PredictionTP53Tour and slight refactoring
dvmichaelpeterseil Sep 2, 2022
9efaeff
Updated Tour2
dvmichaelpeterseil Sep 5, 2022
d4184c1
Updated Tour2
dvmichaelpeterseil Sep 5, 2022
01a3229
Nearly complete DrugTargetDiscoveryTour
dvmichaelpeterseil Sep 27, 2022
0372957
Merge remote-tracking branch 'origin/develop' into dvMike/1365_Additi…
dvmichaelpeterseil Feb 15, 2023
3ad9fe0
Update gitignore
dvmichaelpeterseil Feb 15, 2023
bcbf227
Merge remote-tracking branch 'origin/develop' into dvMike/1365_Additi…
dvmichaelpeterseil Mar 13, 2023
c97bf08
Stash Tour Testing
dvmichaelpeterseil Mar 13, 2023
e2efaf6
Updated tours
dvmichaelpeterseil Mar 23, 2023
ebb9ddb
Add dependency
oltionchampari Mar 23, 2023
5fbb05d
Added blockers to stabilize tour
dvmichaelpeterseil Mar 23, 2023
f433320
Merge branch 'dvMike/1365_Additional-Tours' of github.com:Caleydo/tdp…
dvmichaelpeterseil Mar 23, 2023
fb08f9f
Functional completion of the new tours
dvmichaelpeterseil Mar 30, 2023
f3329a9
Shortened names and descriptions for spacing
dvmichaelpeterseil Apr 3, 2023
787e1c0
Updated tour preview images
dvmichaelpeterseil Apr 3, 2023
1b54d1e
Merge branch 'develop' into dvMike/1365_Additional-Tours
oltionchampari Apr 5, 2023
2fad12f
chore: add missing dist files
thinkh Apr 6, 2023
edbcfc1
Minor fixes and improvments
oltionchampari Apr 7, 2023
ba09b7c
Dist
oltionchampari Apr 7, 2023
963e5c2
fix: add hi-res tour preview images
thinkh Apr 11, 2023
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
Prev Previous commit
Next Next commit
AssessBCCellLines Tour Complete (Unpolished)
  • Loading branch information
dvmichaelpeterseil committed Aug 30, 2022
commit f52de57eeef84bacc94e77240f452163146deb96
201 changes: 164 additions & 37 deletions src/tours/AssessBCCellLines.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export class AssessBCCellLines {
{
selector: '.modal.show .col > .select3',
placement: 'centered',
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(250)),
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(150)),
html: `We select the Cell Line`,
postAction: () => {
TourUtils.setValueAndTrigger('.modal.show .select3 input.select2-search__field', 'HCC1954;', 'input');
Expand Down Expand Up @@ -138,7 +138,7 @@ export class AssessBCCellLines {
{
selector: '.modal.show .col > .select3',
placement: 'centered',
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(250)),
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(150)),
html: `We select the 2nd Cell Line`,
postAction: () => {
TourUtils.setValueAndTrigger('.modal.show .select3 input.select2-search__field', 'HCC1954;', 'input');
Expand Down Expand Up @@ -176,7 +176,7 @@ export class AssessBCCellLines {
{
selector: '.modal.show .col > .select3',
placement: 'centered',
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(250)),
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(150)),
html: `We select the 3rd Cell Line`,
postAction: () => {
TourUtils.setValueAndTrigger('.modal.show .select3 input.select2-search__field', 'HCC1954;', 'input');
Expand Down Expand Up @@ -213,14 +213,14 @@ export class AssessBCCellLines {
html: `Observe: Of the highly amplified genes, ERBB2 (HER2) has the highest expression and the lowest sensitivity score. Therefore, it is probably the most relevant gene of this amplicon.`,
},
{
selector: '.le header [data-col-id="col9"], .le header [data-col-id="col10"]',
selector: ['.le header [data-col-id="col9"], .le header [data-col-id="col10"]'],
html: `<p>Combine both score columns to obtain stacked bars.</p>
<p>Observe: Combining the columns highlights the importance of ERBB2.</p>
<p>It is therefore probably the most relevant gene within this amplified genomic region.</p>`,
placement: 'centered',
},
{
selector: '.le header [data-col-id="col10"]',
selector: '[data-index="0"]',
html: `<p>This finding leads the scientist to the question whether ERBB2 is also highly expressed and frequently amplified in other breast cancer cell lines.</p>
<p>To investigate this, the analyst adds the following columns:
<ul>
Expand All @@ -236,11 +236,10 @@ export class AssessBCCellLines {
html: `1. A column with the average gene expression`,
placement: 'centered',
postAction: () => {
// Add the average gene expression column
TourUtils.click('.lu-side-panel-wrapper .lu-adder > button');
TourUtils.click('[data-testid=lu-adder-div] > .lu-search > .lu-search-list > :nth-child(2) > ul > :nth-child(2) > span');
TourUtils.toggleClass('.lu-adder.once', 'once', false);
TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
return TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
TourUtils.setValueAndTrigger('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select', 'tumortype', 'change');
TourUtils.setValueAndTrigger(
'.show .modal-body form > .col-sm-12:nth-child(1) .row:nth-child(1) .row:nth-child(1) > div:nth-child(2) select',
Expand All @@ -257,12 +256,14 @@ export class AssessBCCellLines {
selector: '.lu-side-panel-wrapper .lu-adder > button',
html: `2. A column with the gene copy number distribution`,
placement: 'centered',
preAction: () => {
TourUtils.waitFor('.le header [data-col-id="col11"]');
},
postAction: () => {
// Add the average gene expression column
TourUtils.click('.lu-side-panel-wrapper .lu-adder > button');
TourUtils.click('[data-testid=lu-adder-div] > .lu-search > .lu-search-list > :nth-child(2) > ul > :nth-child(2) > span');
TourUtils.toggleClass('.lu-adder.once', 'once', false);
TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
return TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
TourUtils.setValueAndTrigger('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select', 'tumortype', 'change');
TourUtils.setValueAndTrigger(
'.show .modal-body form > .col-sm-12:nth-child(1) .row:nth-child(1) .row:nth-child(1) > div:nth-child(2) select',
Expand All @@ -279,12 +280,14 @@ export class AssessBCCellLines {
selector: '.lu-side-panel-wrapper .lu-adder > button',
html: `3. A column with the gene amplification frequency across all breast cancer cell lines`,
placement: 'centered',
preAction: () => {
TourUtils.waitFor('.le header [data-col-id="col12"]');
},
postAction: () => {
// Add the average gene expression column
TourUtils.click('.lu-side-panel-wrapper .lu-adder > button');
TourUtils.click('[data-testid=lu-adder-div] > .lu-search > .lu-search-list > :nth-child(2) > ul > :nth-child(2) > span');
TourUtils.toggleClass('.lu-adder.once', 'once', false);
TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
return TourUtils.waitFor('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select').then(() => {
TourUtils.setValueAndTrigger('.show .modal-body form > div:nth-child(1) .row:nth-child(1) div:nth-child(1) select', 'tumortype', 'change');
TourUtils.setValueAndTrigger(
'.show .modal-body form > .col-sm-12:nth-child(1) .row:nth-child(1) .row:nth-child(1) > div:nth-child(2) select',
Expand All @@ -305,57 +308,181 @@ export class AssessBCCellLines {
selector: '.le.le-multi.lineup-engine',
html: `Observe: ERBB2 is amplified in almost 25% of all assessed breast cancer cell lines. Further, it is highly expressed.`,
placement: 'centered',
preAction: () => {
TourUtils.waitFor('.le header [data-col-id="col13"]');
},
},
{
selector: '.le.le-multi.lineup-engine',
selector: '[data-index="0"] .lu-renderer-selection',
html: `<p>The aim is now to get more information about ERBB2.</p>
<p>Select ERBB2 in the list.</p>`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: '.le.le-multi.lineup-engine',
selector: '[data-viewid="celllinedb_expression_vs_copynumber"]',
html: `Open the Expression vs Copy Number detail view`,
placement: 'centered',
html: `TOUR IS HERE SO FAR.`,
preAction: TourUtils.waitForSelector,
postAction: TourUtils.clickSelector,
},
{
selector: '.le header section[title^=HCC] i[title^=Sort]',
selector: '.ids',
html: `Observe the direct correlation between copy number and expression of ERBB2`,
placement: 'centered',
preAction: () => {
return TourUtils.waitFor('.ids');
},
},
{
selector: '[data-viewid="targetvalidation"]',
html: `Now open the Open Targets detail view...`,
placement: 'centered',
html: `For example, you can use this icon to sort all genes by their copy number in the cell line <i>'HCC-827'</i>`,
postAction: TourUtils.clickSelector,
},
{
selector: '.le-tr[data-index="0"]',
placement: 'centered',
html: `In order to obtain additional information about one or more genes, click on the respective line or use the checkboxes`,
preAction: () =>
TourUtils.waitFor(() => {
const r = document.querySelector<HTMLElement>('.le-tr[data-index="0"]');
if (!r) {
return null;
}
// has a string renderered EGFR entry
if (!Array.from(r.querySelectorAll<HTMLElement>('div[data-renderer="string"]')).some((d) => d.textContent === 'EGFR')) {
return null;
}
return r;
}, Infinity).then(() => TourUtils.wait(500)), // wait for animation to complete
selector: '[data-viewid="pubmed"]',
html: `...and the PubMed detail view.`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: '.viewWrapper .chooser:not(.hidden)',
selector: '',
html: `Question: In what cell lines is ERBB2 amplified? Select cell lines with ERBB2 amplification that have mutation in BRCA1 or BRCA2`,
placement: 'centered',
},
{
selector: '[data-viewid="copynumbertable"]',
html: `Start by opening the Copy Number detail view`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: '[data-id="col7"] .lu-action-sort',
html: `Now sort by the copy number`,
placement: 'centered',
html: `Various 'Detail Views', providing additional information, are available.`,
preAction: TourUtils.waitForSelector,
postAction: TourUtils.clickSelector,
},
{
selector: '[data-testid="viewWrapper-1"] [data-id="col4"] .lu-action-filter',
html: `Filter for breast cancer via column menu of column tumor type (also filter out cell lines with unknown tumor type)`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: '.lu-dialog .lu-dialog-table',
html: `First select only the "breast carcinoma" tumor type.`,
placement: 'centered',
postAction: () => {
TourUtils.wait(100)
.then(() => {
TourUtils.click('.lu-dialog-table .lu-checkbox:first-child');
})
.then(() => {
TourUtils.wait(500).then(() => {
TourUtils.click('input[type="checkbox"][data-cat="breast carcinoma"]');
});
});
},
},
{
selector: '.viewWrapper .chooser button[data-viewid="celllinedb_expression_vs_copynumber"]',
selector: '.lu-dialog .lu-dialog-table',
html: `Then filter cell lines with unknown types and submit the filter.`,
placement: 'centered',
html: `For instance, clicking on <i>'Expression vs Copy Number'</i> opens a scatter plot showing the relation of the two types of data`,
postAction: () => {
TourUtils.wait(100)
.then(() => {
TourUtils.click('.lu-dialog > .lu-checkbox input');
})
.then(() => {
TourUtils.wait(500).then(() => {
TourUtils.click('.lu-dialog-button[type="submit"]');
});
});
},
},
{
selector: '[data-testid="viewWrapper-1"] .lu-side-panel-wrapper .lu-adder > button',
html: `Let's now add the BRCA gene scores.`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: '[data-testid="viewWrapper-1"] [data-testid=lu-adder-div] > .lu-search > .lu-search-list > :nth-child(2) > ul > :nth-child(1) > span',
html: `We want to add a new column`,
placement: 'centered',
postAction: () => {
TourUtils.click(
'[data-testid="viewWrapper-1"] [data-testid=lu-adder-div] > .lu-search > .lu-search-list > :nth-child(2) > ul > :nth-child(1) > span',
);
TourUtils.toggleClass('.lu-adder.once', 'once', false);
},
},
{
selector: '.modal.show .col > .select3',
placement: 'centered',
preAction: () => TourUtils.waitFor('.modal.show').then(() => TourUtils.wait(150)),
html: `We select the BRCA1 and BRCA2 cell lines.`,
postAction: () => {
TourUtils.setValueAndTrigger('.modal.show .select3 input.select2-search__field', 'BRCA1;', 'input');
TourUtils.wait(400).then(() => {
TourUtils.setValueAndTrigger('.modal.show .select3 input.select2-search__field', 'BRCA2;', 'input');
});
},
},
{
selector: '.modal.show .col > .select2',
placement: 'centered',
html: `Then set the data type to AA Mutated.`,
postAction: () => {
TourUtils.setValueAndTrigger('.show .col > select', 'mutation-aa_mutated', 'change');
},
},
{
selector: '.modal.show .modal-footer button[type=submit]',
html: `&hellip; and click <i>'Add'</i>`,
placement: 'centered',
postAction: TourUtils.clickSelector,
},
{
selector: ['[data-testid="viewWrapper-1"] [data-index="0"].le-tr, [data-testid="viewWrapper-1"] [data-index="2"].le-tr'],
html: `<p>Observe:</p>
<p>HCC1954 has the highest ERBB2 amplification among BRCA1 mutated cell lines.</p>
<p>HCC1569 has the highest ERBB2 amplification among BRCA2 mutated cell lines.</p>`,
placement: 'centered',
},
{
selector: '',
html: `Aim: Show information provided by COSMIC about these two cell lines`,
placement: 'centered',
},
{
selector: ['[data-testid="viewWrapper-1"] [data-index="0"].le-tr, [data-testid="viewWrapper-1"] [data-index="2"].le-tr'],
html: `Select HCC1954 and HCC1569`,
placement: 'centered',
postAction: () => {
TourUtils.click('[data-testid="viewWrapper-1"] [data-index="0"] .lu-renderer-selection');
TourUtils.click('[data-testid="viewWrapper-1"] [data-index="2"] .lu-renderer-selection');
},
},
{
selector: '[data-testid="viewWrapper-1"] [data-viewid="cosmic"]',
html: `Open the COSMIC detail view`,
placement: 'centered',
preAction: TourUtils.waitForSelector,
postAction: TourUtils.clickSelector,
},
{
selector: '[data-testid="viewWrapper-2"] select',
html: `Use the drop-down menu to switch between the two cell lines.`,
placement: 'centered',
preAction: TourUtils.waitForSelector,
postAction: TourUtils.clickSelector,
},
{
html: `<p>Thanks for joining this tour demonstrating the basic features of Ordino.</p>
<p>There are many more features to discover. Enjoy!</p>`,
html: `<p>Thanks for joining this tour demonstrating the assessment of breast cancer cell lines.</p>
<p>There are still many more features to discover. Enjoy!</p>`,
},
];
}
Expand Down