Skip to content

Commit 994b8fd

Browse files
authored
Merge pull request #142 from maxibor/viewer_doc
Viewer doc
2 parents a485ff4 + 7ab8a81 commit 994b8fd

File tree

4 files changed

+13
-50
lines changed

4 files changed

+13
-50
lines changed
181 KB
Loading
127 KB
Loading

docs/source/how_to/viewer.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The purpose of the `viewer` command is to provide a easy-to-use graphical-user i
1313
> ⚠️ _The `viewer` tool was previously named `filter`, and might still be referred as such in some parts of the documentation._
1414
1515
For video based walkthroughs please see [Tutorials](/tutorials/viewer.md).
16+
1617
## When
1718

1819
You should use this tool when you wish to find particular types of ancient metagenomic data, but wish to explore the dataset manually and interactively (i.e., don't know exactly what you're looking for yet), and/or if you do not wish to download the AncientMetagenomeDir full tables yourself and filter them within languages such as R or Python (with pandas).
@@ -87,7 +88,15 @@ Now validate your selection! Press the 'Validate selection' button at the bottom
8788

8889
> ⚠️ _If you wish to download the data, make sure you have already selected your 'Data download method' in the sidebar before pressing 'Validate selection'!_
8990
90-
Once the select is validated, more buttons will appear allowing you to download different files
91+
Once the selection is validated, the library filtering table will appear below
92+
93+
![AMDirT libraries filtering table](images/amdirt-filter-libraries-table.png)
94+
95+
You can proceed to select your libraries of choice (or all of them) in the same way as the samples table. Once happy, you can then click on 'Validate library selection'
96+
97+
Your different download options will finally appear:
98+
99+
![AMDirT output download options](images/amdirt-filter-download-buttons.png)
91100

92101
In this case we suggest you press:
93102

@@ -97,8 +106,6 @@ In this case we suggest you press:
97106

98107
See [Output](#output) for descriptions of all output possible files.
99108

100-
![AMDirT buttons after selection validation](images/amdirt-filter-validate-buttons.png)
101-
102109
To use the **download** script, you can simply run:
103110

104111
```bash

docs/source/tutorials/viewer.md

Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,8 @@
11
# viewer
22

3-
On this page we provide step-by-step video tutorials on how to use the AMDirT graphical-user-interface (GUI) of the `viewer` command.
4-
5-
> ℹ️ _The `viewer` subcommand was previously known as `filter`._
6-
7-
The [full walkthrough](#full-walkthrough) of all steps in a single video can be seen at the end of this page.
8-
9-
## Loading AMDirT viewer
10-
11-
This tutorial shows how to activate a [pre-created](README#install) conda environment from a command-line interface, and load the graphical-user interface (GUI) in your browser.
12-
13-
<iframe width="560" height="315" src="https://www.youtube.com/embed/EANpFh__6V8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
14-
15-
## Selecting Table
16-
17-
This tutorial shows you how to select which release of AncientMetagenomeDir you wish to explore, as well as how to select the given research-area specific AncientMetagenomeDir table of interest.
18-
19-
<iframe width="560" height="315" src="https://www.youtube.com/embed/dUzeJfSTQCU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
20-
21-
## Row Selection
22-
23-
This tutorial shows how to increase the number of rows in the tabular view of the GUI.
24-
25-
<iframe width="560" height="315" src="https://www.youtube.com/embed/DFHlGQcREy0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
26-
27-
## Column Options
28-
29-
This tutorial shows you how to reorder columns, hide/display columns, and filter columns by the particular specifications of the user.
30-
31-
<iframe width="560" height="315" src="https://www.youtube.com/embed/uRPkvGum19A" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
32-
33-
## Selecting Rows
34-
35-
This tutorial shows how to select different rows of interest.
36-
37-
<iframe width="560" height="315" src="https://www.youtube.com/embed/-EnIIMEIGgA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
38-
39-
## Exporting Information
40-
41-
This tutorial shows how to export the selected data for downstream use, in this case, download scripts and a input table for the [nf-core/eager](https://nf-co.re/eager) ancient DNA pipeline.
3+
On this page we provide a step-by-step video tutorial on how to use the AMDirT graphical-user-interface (GUI) of the `viewer` command.
424

435
For more detail about all possible output files, please see the corresponding pages on [How To](/how_to/index).
446

45-
<iframe width="560" height="315" src="https://www.youtube.com/embed/Re6YAdGmm7w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay;
46-
clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
47-
48-
## Full walkthrough
49-
50-
This tutorial has all the above steps in a single video to show the full procedure from beginning to end.
51-
52-
<iframe width="560" height="315" src="https://www.youtube.com/embed/iWrHJFG7Ky0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
7+
<iframe width="560" height="315" src="https://www.youtube.com/embed/7qcGXIEt9As" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay;
8+
clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

0 commit comments

Comments
 (0)