Skip to content

Commit

Permalink
Added argsoap with custom db to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
davidecrs committed Dec 27, 2024
1 parent c04f4f0 commit 69a1a0f
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ walkthrough/tutorial
tips/suggestions
tips/faq
tips/toolcustomdb
```

```{toctree}
Expand Down
16 changes: 10 additions & 6 deletions docs/source/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@ The full tree of dependencies among all modules is shown here.
To summarise, the dependency tree has to be considered when ignoring specific modules, as they may inadvertently block other modules in the current or the next stream of analysis.

<style type="text/css">
.tg {border-collapse:collapse;border-color:#9ABAD9;border-spacing:0;margin:0px auto;}
.tg {border-collapse:collapse;border-color:#9ABAD9;border-spacing:0;}
.tg td{background-color:#EBF5FF;border-color:#9ABAD9;border-style:solid;border-width:1px;color:#444;
font-family:Arial, sans-serif;font-size:14px;overflow:hidden;padding:10px 5px;word-break:normal;}
.tg th{background-color:#409cff;border-color:#9ABAD9;border-style:solid;border-width:1px;color:#fff;
font-family:Arial, sans-serif;font-size:14px;font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;}
.tg .tg-9wq8{border-color:inherit;text-align:center;vertical-align:middle}
.tg .tg-9tkk{border-color:#9abad9;text-align:center;vertical-align:middle}
.tg .tg-njus{border-color:inherit;font-weight:bold;position:-webkit-sticky;position:sticky;text-align:center;
text-decoration:underline;top:-1px;vertical-align:middle;will-change:transform}
.tg .tg-uzvj{border-color:inherit;font-weight:bold;text-align:center;vertical-align:middle}
@media screen and (max-width: 767px) {.tg {width: auto !important;}.tg col {width: auto !important;}.tg-wrap {overflow-x: auto;-webkit-overflow-scrolling: touch;margin: auto 0px;}}</style>
@media screen and (max-width: 767px) {.tg {width: auto !important;}.tg col {width: auto !important;}.tg-wrap {overflow-x: auto;-webkit-overflow-scrolling: touch;}}</style>
<div class="tg-wrap"><table class="tg"><thead>
<tr>
<th class="tg-njus">Stream-level</th>
Expand All @@ -46,7 +47,7 @@ To summarise, the dependency tree has to be considered when ignoring specific mo
</tr></thead>
<tbody>
<tr>
<td class="tg-uzvj" rowspan="7">Read-based</td>
<td class="tg-uzvj" rowspan="8">Read-based</td>
<td class="tg-9wq8" rowspan="3">Pre Processing</td>
<td class="tg-9wq8">fastp</td>
</tr>
Expand All @@ -61,7 +62,10 @@ To summarise, the dependency tree has to be considered when ignoring specific mo
<td class="tg-9wq8">fastqc + reads count</td>
</tr>
<tr>
<td class="tg-9wq8">Functional Annotation</td>
<td class="tg-9tkk" rowspan="2">Functional Annotation</td>
<td class="tg-9tkk">ARGs-OAP with Custom DB</td>
</tr>
<tr>
<td class="tg-9wq8">mi-faser</td>
</tr>
<tr>
Expand All @@ -72,7 +76,7 @@ To summarise, the dependency tree has to be considered when ignoring specific mo
<td class="tg-9wq8">metaPhlAn</td>
</tr>
<tr>
<td class="tg-uzvj" rowspan="16">Assembly-Based</td>
<td class="tg-uzvj" rowspan="16">Assembly Based</td>
<td class="tg-9wq8" rowspan="2">Assembly</td>
<td class="tg-9wq8">metaSPAdes</td>
</tr>
Expand Down Expand Up @@ -131,7 +135,7 @@ To summarise, the dependency tree has to be considered when ignoring specific mo
<td class="tg-9wq8">Bakta</td>
</tr>
<tr>
<td class="tg-uzvj" rowspan="12">Binning-Based</td>
<td class="tg-uzvj" rowspan="12">Binning Based</td>
<td class="tg-9wq8">Binning</td>
<td class="tg-9wq8">Multi-Binners (Metabat2 + MaxBin2 + SemiBin2)</td>
</tr>
Expand Down
38 changes: 38 additions & 0 deletions docs/source/tips/toolcustomdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Tools with custom database

In this page you will find some suggestion on how to setup custom db for specific tools.

<br>

## ARGs-OAP with Custom DB

(Module: `func_classification_rb`)

For detailed documentation, please refer to the ARGs-OAP Repository: [https://github.com/xinehc/args_oap](https://github.com/xinehc/args_oap)

I will try to simplify based also on my experience using this tool. Moreover some checks will be performed on the provided files to avoid later issues with the code.

You need two files:

- A fasta file of protein sequences, named for example `sequences.fasta` (Do not put space in the filename).
We suggest to make this file as simple as possible. The header of each sequence should contain just the ID without any space, tab, or other irregular characters such as forward slash.
Avoid duplicated headers and duplicated sequences.

```
>id1
DQEATRFKT...
>id2
GWTRCMDCQ...
```


- A file named `mapping.tsv`, which is tab-separated.
This file should contain at least one column, describing all the IDs of the fasta sequences.
However you can put more columns, each one representing Class, Subclass or categories of your interests.
Do not put space in the column name. We suggest putting "_" instead of spaces. Geomosaic will make some checks.

```
IDs Class Subclass Metal_Resistances
id1 class1 subclass1 iron
id2 class2 subclass2 iron
```

0 comments on commit 69a1a0f

Please sign in to comment.