Skip to content

Commit b7d6ebf

Browse files
authored
Merge pull request #96 from genestack/feature/advGuide-quickStart
Ex Quick Start Guide page is updated
2 parents cb01017 + 80122e1 commit b7d6ebf

File tree

7 files changed

+38
-17
lines changed

7 files changed

+38
-17
lines changed
4.3 MB
Loading
6.84 MB
Loading
23.3 MB
Loading
192 KB
Loading
Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# User Quick Start Guide
1+
# Start
2+
3+
On this page we briefly show main pages of the ODM: Dashboard, Study Browser, Metadata Editor.
4+
5+
For more details about Study Browser and Metadata Editor functionality refer to corresponding guide page.
6+
7+
![StartGIF](doc-odm-user-guide/gif/start.gif)
28

39
The first thing you see when logging in to Open Data Manager is the Dashboard:
410

@@ -11,28 +17,43 @@ link from the dashboard takes you to the Study Browser to help you do this.
1117

1218
## Study Browser
1319

14-
![image](doc-odm-user-guide/images/quickstart_user_studybrowser.png)
20+
!!! info "Limitation"
21+
Only Studies you have permission to observe (Studies created by you or Studies shared with your group of users
22+
by another user) are displayed as default.
1523

16-
By default all studies are shown that you have permission to see, but since you aren’t expected to scroll through
17-
thousands of studies there are, of course, search and filtering options to help you find studies of interest.
18-
These are given in the left hand panel of the Study Browser and they allow you to search by study name, accession or
19-
by the text present in any metadata field.
24+
There is search and filtering options to help you find studies of interest.
25+
Facets in the left hand panel of the Study Browser and Search bar allow you to search by study name, accession or
26+
by any value presented in any metadata field.
2027

21-
#### NOTE
28+
!!! tip
29+
Harmonising your Study and its child entities (Samples, Libraries, Preparations, Data) Metadata values by using
30+
configurable validation rules helps you to find all relevant values by preventing missed results due to
31+
non-standard terms usage.
2232

23-
Harmonising your study and sample data (metadata) texts by using controlled vocabularies and ontologies helps searches find all relevant data by preventing missed results due to misspellings or non-standard term usage
33+
The search is also aware of controlled dictionary/ontology and will expand results to include synonyms, with optional
34+
extension to include child terms.
35+
Click on the question mark next to the search bar to open `Help` with more details about advanced search functionality.
2436

25-
The search is also controlled vocabulary/ontology aware and will expand results to include synonyms, with optional extension to include child terms. You can use asterisks (\*) to allow any positive number of wildcard characters: “*ale” will find “male” and “female” for example. Click on the question mark next to the search bar to open \*\*Help\** with more details about advanced search functionality.
37+
![SearchHelpGIF](doc-odm-user-guide/gif/search_help.gif)
2638

27-
The facets beneath the search bar allow you to filter down the results of a search based on the samaple data (metadata) fields that
28-
are present in your results.
39+
The facets on the left side allow you to filter down the results of a search based on the metadata fields that
40+
are presented in your results.
2941

30-
To access more details about a study and to explore it further click the name of the study which will launch
31-
the Metadata Editor in a new tab.
42+
![FacetsGIF](doc-odm-user-guide/gif/facets.gif)
43+
44+
You can find more about Search functionality on [Study Browser](../doc-odm-user-guide/studybrowser.md) page
45+
of this guide.
3246

3347
## Metadata Editor
3448

49+
To access more details about a study and to explore it further click the name of the study which will launch
50+
the **Metadata Editor** in a new tab.
51+
3552
![image](doc-odm-user-guide/images/quickstart_user_studymetainfoeditor.png)
3653

37-
The Metadata Editor allows you to see all the information about a study, the samples contained in the study and any
38-
signal data types associated with the study, for example, expression or variant data.
54+
The Metadata Editor allows you to see all the information about a Study metadata, Samples, Libraries, and Preparations
55+
metadata contained in the Study and any Data Classes (signal data and attached files) associated with the Study,
56+
for example, expression or variant data.
57+
58+
You can find more about this functionality on [Metadata Editor](../doc-odm-user-guide/metadata-editor.md) page
59+
of this guide.

docs/user-guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Want to know more? Learn more by watching our videos below.
6565

6666
## In Depth User Guide Articles
6767

68-
* [User Quick Start Guide](doc-odm-user-guide/quickstart_user.md)
68+
* [Start](doc-odm-user-guide/quickstart_user.md)
6969
* [Dashboard](doc-odm-user-guide/quickstart_user.md#dashboard)
7070
* [Study Browser](doc-odm-user-guide/quickstart_user.md#study-browser)
7171
* [Metadata Editor](doc-odm-user-guide/quickstart_user.md#metadata-editor)

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ nav:
2222
- About Genestack: https://genestack.com/
2323
- Advanced Guide:
2424
- user-guide/index.md
25-
- Quick Start Guide: user-guide/doc-odm-user-guide/quickstart_user.md
25+
- Start: user-guide/doc-odm-user-guide/quickstart_user.md
2626
- User Setup: user-guide/doc-odm-user-guide/setup.md
2727
- Create New Study: user-guide/doc-odm-user-guide/create-study.md
2828
- Import Data on ODM: user-guide/doc-odm-user-guide/import-samples-spreadsheet.md

0 commit comments

Comments
 (0)