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

[MNT] Updated help text and category explanations of the annotation page #654

Merged
merged 5 commits into from
Dec 6, 2023
Merged

[MNT] Updated help text and category explanations of the annotation page #654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5aeddc1
Added `next-page` instructions for annotation page
rmanaem Dec 5, 2023
1859d3c
Updated categories explanation text
rmanaem Dec 5, 2023
c9e6a2c
Removd the warning about using back button from README.md
rmanaem Dec 5, 2023
6b3acf2
Fixed typo
rmanaem Dec 5, 2023
bcc10cf
Added comment for `explanation` field of categories state object
rmanaem Dec 5, 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
3 changes: 0 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,6 @@ See the [Nuxt documentation](https://nuxtjs.org/deployments/github-pages/) for m

There are two means of moving forward to the next step in the annotation tool's workflow: (1) the <span style="color:green;">navbar</span> at the top right of the screen which features the page names, and (2) the <span style="color:green;">next page buttons</span> on the bottom right of each page.

:warning: Do not use the browser back/forward buttons for navigation as this is currently a limitation of the tool
that may lead to breaking the workflow.

rmanaem marked this conversation as resolved.
Show resolved Hide resolved
Certain criteria for each page need to be be met in order to move forward. Instructions are offered above the <span style="color:green;">next page button</span>. Once the criteria have been met <span style="color:green;">navbar</span> and <span style="color:green;">next page button</span> will turn from gray to green.

## Testing
Expand Down
6 changes: 5 additions & 1 deletion components/annot-explanation.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@
{{ uiText.cardTitle }}
</b-card-header>
<b-card-body>
<b-card-text>{{ explanationText }}</b-card-text>
<b-card-text><ul>
<li v-for="(sentence, index) in explanationText.split('.')" :key="index">
{{ sentence }}.
rmanaem marked this conversation as resolved.
Show resolved Hide resolved
</li>
</ul></b-card-text>
</b-card-body>
</b-card>

Expand Down
2 changes: 1 addition & 1 deletion components/next-page.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

"home": "",
"categorization": "One column must be categorized as 'Subject ID' and all assessment tools must be grouped to proceed",
"annotation": ""
"annotation": "One categroized column must be annotated to proceed"
}
}
};
Expand Down
9 changes: 5 additions & 4 deletions store/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export const state = () => ({
"Diagnosis": diagnosisTerms
},

// The explanation strings for each category, will be split by '.' and turned into bullet points in the annot-explanation component
categories: {

"Subject ID": {
Expand All @@ -36,25 +37,25 @@ export const state = () => ({
"Age": {

componentName: "annot-continuous-values",
explanation: "This is an explanation for how to annotate age.",
explanation: "Review the annotated columns for Age. Mark missing values. Select a transformation heuristic, check the preview, and finalize the harmonization",
rmanaem marked this conversation as resolved.
Show resolved Hide resolved
identifier: "nb:Age"
},
"Sex": {

componentName: "annot-categorical",
explanation: "This is an explanation for how to annotate sex.",
explanation: "Review the annotated columns for Sex. Mark missing values. Annotate each unique value from the dropdown, and finalize the harmonization",
identifier: "nb:Sex"
},
"Diagnosis": {

componentName: "annot-categorical",
explanation: "This is an explanation for how to annotate diagnosis.",
explanation: "Review the annotated columns for Diagnosis. Mark missing values. Annotate each unique value from the dropdown, and finalize the harmonization",
identifier: "nb:Diagnosis"
},
"Assessment Tool": {

componentName: "annot-tool-groups",
explanation: "This is an explanation for how to annotate a tool.",
explanation: "Review the annotated columns for Assessment Tool. Mark missing values for each tool",
identifier: "nb:AssessmentTool"
}
},
Expand Down
Loading